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

TimedGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::TimedGotoMessage:

Public Member Functions

 TimedGotoMessage (const float ini_time_sec, const float ini_pan, const float ini_tilt)
 Constructor with initial values. More...
 
 TimedGotoMessage ()
 Constructor. More...
 
 ~TimedGotoMessage ()
 Destructor. More...
 
 TimedGotoMessage (const TimedGotoMessage *m)
 Copy constructor. More...
 
float time_sec () const
 Get time_sec value. More...
 
void set_time_sec (const float new_time_sec)
 Set time_sec value. More...
 
size_t maxlenof_time_sec () const
 Get maximum length of time_sec value. More...
 
float pan () const
 Get pan value. More...
 
void set_pan (const float new_pan)
 Set pan value. More...
 
size_t maxlenof_pan () const
 Get maximum length of pan value. More...
 
float tilt () const
 Get tilt value. More...
 
void set_tilt (const float new_tilt)
 Set tilt value. More...
 
size_t maxlenof_tilt () const
 Get maximum length of tilt value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

TimedGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 192 of file PanTiltInterface.h.

Constructor & Destructor Documentation

◆ TimedGotoMessage() [1/3]

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

Constructor with initial values.

Parameters
ini_time_secinitial value for time_sec
ini_paninitial value for pan
ini_tiltinitial value for tilt

Definition at line 1044 of file PanTiltInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

◆ TimedGotoMessage() [2/3]

fawkes::PanTiltInterface::TimedGotoMessage::TimedGotoMessage ( )

◆ ~TimedGotoMessage()

fawkes::PanTiltInterface::TimedGotoMessage::~TimedGotoMessage ( )

Destructor.

Definition at line 1072 of file PanTiltInterface.cpp.

References fawkes::Message::data_ptr.

◆ TimedGotoMessage() [3/3]

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

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1080 of file PanTiltInterface.cpp.

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

Member Function Documentation

◆ clone()

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 1188 of file PanTiltInterface.cpp.

◆ maxlenof_pan()

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 1137 of file PanTiltInterface.cpp.

◆ maxlenof_tilt()

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 1167 of file PanTiltInterface.cpp.

◆ maxlenof_time_sec()

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 1106 of file PanTiltInterface.cpp.

◆ pan()

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

Get pan value.

Current pan.

Returns
pan value

Definition at line 1127 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

◆ set_pan()

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

Set pan value.

Current pan.

Parameters
new_pannew pan value

Definition at line 1147 of file PanTiltInterface.cpp.

◆ set_tilt()

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

Set tilt value.

Current tilt.

Parameters
new_tiltnew tilt value

Definition at line 1177 of file PanTiltInterface.cpp.

◆ set_time_sec()

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 1117 of file PanTiltInterface.cpp.

◆ tilt()

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

Get tilt value.

Current tilt.

Returns
tilt value

Definition at line 1157 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

◆ time_sec()

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 1096 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().


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