fawkes::PanTiltInterface::SetVelocityMessage Class Reference

SetVelocityMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/PanTiltInterface.h>

Inheritance diagram for fawkes::PanTiltInterface::SetVelocityMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetVelocityMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetVelocityMessage (const float ini_pan_velocity, const float ini_tilt_velocity)
 Constructor with initial values.
 SetVelocityMessage ()
 Constructor.
 ~SetVelocityMessage ()
 Destructor.
 SetVelocityMessage (const SetVelocityMessage *m)
 Copy constructor.
float pan_velocity () const
 Get pan_velocity value.
void set_pan_velocity (const float new_pan_velocity)
 Set pan_velocity value.
size_t maxlenof_pan_velocity () const
 Get maximum length of pan_velocity value.
float tilt_velocity () const
 Get tilt_velocity value.
void set_tilt_velocity (const float new_tilt_velocity)
 Set tilt_velocity value.
size_t maxlenof_tilt_velocity () const
 Get maximum length of tilt_velocity value.
virtual Message * clone () const
 Clone this message.

Detailed Description

SetVelocityMessage Fawkes BlackBoard Interface Message.

Definition at line 207 of file PanTiltInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_pan_velocity initial value for pan_velocity
ini_tilt_velocity initial value for tilt_velocity

Definition at line 1229 of file PanTiltInterface.cpp.

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

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

Constructor.

Definition at line 1241 of file PanTiltInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 1252 of file PanTiltInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 1260 of file PanTiltInterface.cpp.

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

Member Function Documentation

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

References SetVelocityMessage().

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

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

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

Get pan_velocity value.

Maximum pan velocity currently reached.

Returns:
pan_velocity value

Definition at line 1274 of file PanTiltInterface.cpp.

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

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

Set pan_velocity value.

Maximum pan velocity currently reached.

Parameters:
new_pan_velocity new pan_velocity value

Definition at line 1294 of file PanTiltInterface.cpp.

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

Set tilt_velocity value.

Maximum tilt velocity currently reached.

Parameters:
new_tilt_velocity new tilt_velocity value

Definition at line 1324 of file PanTiltInterface.cpp.

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

Get tilt_velocity value.

Maximum tilt velocity currently reached.

Returns:
tilt_velocity value

Definition at line 1304 of file PanTiltInterface.cpp.

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

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