Fawkes API  Fawkes Development Version
fawkes::PanTiltInterface::TimedGotoMessage Class Reference

TimedGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::TimedGotoMessage:

List of all members.

Classes

struct  TimedGotoMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 TimedGotoMessage (const float ini_time_sec, const float ini_pan, const float ini_tilt)
 Constructor with initial values.
 TimedGotoMessage ()
 Constructor.
 ~TimedGotoMessage ()
 Destructor.
 TimedGotoMessage (const TimedGotoMessage *m)
 Copy constructor.
float time_sec () const
 Get time_sec value.
void set_time_sec (const float new_time_sec)
 Set time_sec value.
size_t maxlenof_time_sec () const
 Get maximum length of time_sec value.
float pan () const
 Get pan value.
void set_pan (const float new_pan)
 Set pan value.
size_t maxlenof_pan () const
 Get maximum length of pan value.
float tilt () const
 Get tilt value.
void set_tilt (const float new_tilt)
 Set tilt value.
size_t maxlenof_tilt () const
 Get maximum length of tilt value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::PanTiltInterface::TimedGotoMessage::TimedGotoMessage ( const float  ini_time_sec,
const float  ini_pan,
const float  ini_tilt 
)
fawkes::PanTiltInterface::TimedGotoMessage::~TimedGotoMessage ( )

Destructor.

Definition at line 1070 of file PanTiltInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::PanTiltInterface::TimedGotoMessage::TimedGotoMessage ( const TimedGotoMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1078 of file PanTiltInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, and fawkes::Message::data_ts.


Member Function Documentation

Message * fawkes::PanTiltInterface::TimedGotoMessage::clone ( ) const [virtual]

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns:
clone of this message

Reimplemented from fawkes::Message.

Definition at line 1186 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_pan ( ) const

Get maximum length of pan value.

Returns:
length of pan value, can be length of the array or number of maximum number of characters for a string

Definition at line 1135 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_tilt ( ) const

Get maximum length of tilt value.

Returns:
length of tilt value, can be length of the array or number of maximum number of characters for a string

Definition at line 1165 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

Returns:
length of time_sec value, can be length of the array or number of maximum number of characters for a string

Definition at line 1104 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::TimedGotoMessage::pan ( ) const

Get pan value.

Current pan.

Returns:
pan value

Definition at line 1125 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::pan.

Referenced by PanTiltRX28Thread::loop().

void fawkes::PanTiltInterface::TimedGotoMessage::set_pan ( const float  new_pan)

Set pan value.

Current pan.

Parameters:
new_pannew pan value

Definition at line 1145 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::pan.

void fawkes::PanTiltInterface::TimedGotoMessage::set_tilt ( const float  new_tilt)

Set tilt value.

Current tilt.

Parameters:
new_tiltnew tilt value

Definition at line 1175 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::tilt.

void fawkes::PanTiltInterface::TimedGotoMessage::set_time_sec ( const float  new_time_sec)

Set time_sec value.

Time in seconds when to reach the final position.

Parameters:
new_time_secnew time_sec value

Definition at line 1115 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::TimedGotoMessage::tilt ( ) const

Get tilt value.

Current tilt.

Returns:
tilt value

Definition at line 1155 of file PanTiltInterface.cpp.

References fawkes::PanTiltInterface::PanTiltInterface_data_t::tilt.

Referenced by PanTiltRX28Thread::loop().

float fawkes::PanTiltInterface::TimedGotoMessage::time_sec ( ) const

Get time_sec value.

Time in seconds when to reach the final position.

Returns:
time_sec value

Definition at line 1094 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().


The documentation for this class was generated from the following files: