fawkes::MotorInterface::TransMessage Class Reference

TransMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::TransMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  TransMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 TransMessage (const float ini_vx, const float ini_vy)
 Constructor with initial values.
 TransMessage ()
 Constructor.
 ~TransMessage ()
 Destructor.
 TransMessage (const TransMessage *m)
 Copy constructor.
float vx () const
 Get vx value.
void set_vx (const float new_vx)
 Set vx value.
size_t maxlenof_vx () const
 Get maximum length of vx value.
float vy () const
 Get vy value.
void set_vy (const float new_vy)
 Set vy value.
size_t maxlenof_vy () const
 Get maximum length of vy value.
virtual Message * clone () const
 Clone this message.

Detailed Description

TransMessage Fawkes BlackBoard Interface Message.

Definition at line 239 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::TransMessage::TransMessage ( const float  ini_vx,
const float  ini_vy 
)

Constructor with initial values.

Parameters:
ini_vx initial value for vx
ini_vy initial value for vy

Definition at line 1248 of file MotorInterface.cpp.

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

fawkes::MotorInterface::TransMessage::TransMessage (  ) 

Constructor.

Definition at line 1260 of file MotorInterface.cpp.

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

Referenced by clone().

fawkes::MotorInterface::TransMessage::~TransMessage (  ) 

Destructor.

Definition at line 1271 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::MotorInterface::TransMessage::TransMessage ( const TransMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1279 of file MotorInterface.cpp.

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

Member Function Documentation

Message * fawkes::MotorInterface::TransMessage::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 1354 of file MotorInterface.cpp.

References TransMessage().

size_t fawkes::MotorInterface::TransMessage::maxlenof_vx (  )  const

Get maximum length of vx value.

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

Definition at line 1303 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::TransMessage::maxlenof_vy (  )  const

Get maximum length of vy value.

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

Definition at line 1333 of file MotorInterface.cpp.

void fawkes::MotorInterface::TransMessage::set_vx ( const float  new_vx  ) 

Set vx value.

Speed in X direction in m/s.

Parameters:
new_vx new vx value

Definition at line 1313 of file MotorInterface.cpp.

void fawkes::MotorInterface::TransMessage::set_vy ( const float  new_vy  ) 

Set vy value.

Speed in Y direction in m/s.

Parameters:
new_vy new vy value

Definition at line 1343 of file MotorInterface.cpp.

float fawkes::MotorInterface::TransMessage::vx (  )  const

Get vx value.

Speed in X direction in m/s.

Returns:
vx value

Definition at line 1293 of file MotorInterface.cpp.

float fawkes::MotorInterface::TransMessage::vy (  )  const

Get vy value.

Speed in Y direction in m/s.

Returns:
vy value

Definition at line 1323 of file MotorInterface.cpp.

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