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

SetVelocityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::SetVelocityMessage:

Public Member Functions

 SetVelocityMessage (const float ini_pan_velocity, const float ini_tilt_velocity)
 Constructor with initial values. More...
 
 SetVelocityMessage ()
 Constructor. More...
 
 ~SetVelocityMessage ()
 Destructor. More...
 
 SetVelocityMessage (const SetVelocityMessage *m)
 Copy constructor. More...
 
float pan_velocity () const
 Get pan_velocity value. More...
 
void set_pan_velocity (const float new_pan_velocity)
 Set pan_velocity value. More...
 
size_t maxlenof_pan_velocity () const
 Get maximum length of pan_velocity value. More...
 
float tilt_velocity () const
 Get tilt_velocity value. More...
 
void set_tilt_velocity (const float new_tilt_velocity)
 Set tilt_velocity value. More...
 
size_t maxlenof_tilt_velocity () const
 Get maximum length of tilt_velocity 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

Constructor & Destructor Documentation

◆ SetVelocityMessage() [1/3]

fawkes::PanTiltInterface::SetVelocityMessage::SetVelocityMessage ( const float  ini_pan_velocity,
const float  ini_tilt_velocity 
)

Constructor with initial values.

Parameters
ini_pan_velocityinitial value for pan_velocity
ini_tilt_velocityinitial value for tilt_velocity

Definition at line 1293 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.

◆ SetVelocityMessage() [2/3]

fawkes::PanTiltInterface::SetVelocityMessage::SetVelocityMessage ( )

◆ ~SetVelocityMessage()

fawkes::PanTiltInterface::SetVelocityMessage::~SetVelocityMessage ( )

Destructor.

Definition at line 1318 of file PanTiltInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetVelocityMessage() [3/3]

fawkes::PanTiltInterface::SetVelocityMessage::SetVelocityMessage ( const SetVelocityMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1326 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::SetVelocityMessage::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 1402 of file PanTiltInterface.cpp.

◆ maxlenof_pan_velocity()

size_t fawkes::PanTiltInterface::SetVelocityMessage::maxlenof_pan_velocity ( ) const

Get maximum length of pan_velocity value.

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

Definition at line 1351 of file PanTiltInterface.cpp.

◆ maxlenof_tilt_velocity()

size_t fawkes::PanTiltInterface::SetVelocityMessage::maxlenof_tilt_velocity ( ) const

Get maximum length of tilt_velocity value.

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

Definition at line 1381 of file PanTiltInterface.cpp.

◆ pan_velocity()

float fawkes::PanTiltInterface::SetVelocityMessage::pan_velocity ( ) const

Get pan_velocity value.

Maximum pan velocity currently reached.

Returns
pan_velocity value

Definition at line 1341 of file PanTiltInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::loop(), and PanTiltRX28Thread::loop().

◆ set_pan_velocity()

void fawkes::PanTiltInterface::SetVelocityMessage::set_pan_velocity ( const float  new_pan_velocity)

Set pan_velocity value.

Maximum pan velocity currently reached.

Parameters
new_pan_velocitynew pan_velocity value

Definition at line 1361 of file PanTiltInterface.cpp.

◆ set_tilt_velocity()

void fawkes::PanTiltInterface::SetVelocityMessage::set_tilt_velocity ( const float  new_tilt_velocity)

Set tilt_velocity value.

Maximum tilt velocity currently reached.

Parameters
new_tilt_velocitynew tilt_velocity value

Definition at line 1391 of file PanTiltInterface.cpp.

◆ tilt_velocity()

float fawkes::PanTiltInterface::SetVelocityMessage::tilt_velocity ( ) const

Get tilt_velocity value.

Maximum tilt velocity currently reached.

Returns
tilt_velocity value

Definition at line 1371 of file PanTiltInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::loop(), and PanTiltRX28Thread::loop().


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