Fawkes API  Fawkes Development Version
fawkes::MotorInterface::LinTransRotMessage Class Reference

LinTransRotMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::LinTransRotMessage:

List of all members.

Classes

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

Public Member Functions

 LinTransRotMessage (const float ini_vx, const float ini_vy, const float ini_omega)
 Constructor with initial values.
 LinTransRotMessage ()
 Constructor.
 ~LinTransRotMessage ()
 Destructor.
 LinTransRotMessage (const LinTransRotMessage *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.
float omega () const
 Get omega value.
void set_omega (const float new_omega)
 Set omega value.
size_t maxlenof_omega () const
 Get maximum length of omega value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::MotorInterface::LinTransRotMessage::LinTransRotMessage ( const float  ini_vx,
const float  ini_vy,
const float  ini_omega 
)
fawkes::MotorInterface::LinTransRotMessage::~LinTransRotMessage ( )

Destructor.

Definition at line 1847 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::MotorInterface::LinTransRotMessage::LinTransRotMessage ( const LinTransRotMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1855 of file MotorInterface.cpp.

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


Member Function Documentation

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

size_t fawkes::MotorInterface::LinTransRotMessage::maxlenof_omega ( ) const

Get maximum length of omega value.

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

Definition at line 1940 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::LinTransRotMessage::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 1880 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::LinTransRotMessage::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 1910 of file MotorInterface.cpp.

float fawkes::MotorInterface::LinTransRotMessage::omega ( ) const

Get omega value.

Rotational speed in rad/s.

Returns:
omega value

Definition at line 1930 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::omega.

void fawkes::MotorInterface::LinTransRotMessage::set_omega ( const float  new_omega)

Set omega value.

Rotational speed in rad/s.

Parameters:
new_omeganew omega value

Definition at line 1950 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::omega.

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

Set vx value.

Speed for translation in X direction in m/s.

Parameters:
new_vxnew vx value

Definition at line 1890 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::vx.

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

Set vy value.

Speed for translation in Y direction in m/s.

Parameters:
new_vynew vy value

Definition at line 1920 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::vy.

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

Get vx value.

Speed for translation in X direction in m/s.

Returns:
vx value

Definition at line 1870 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::vx.

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

Get vy value.

Speed for translation in Y direction in m/s.

Returns:
vy value

Definition at line 1900 of file MotorInterface.cpp.

References fawkes::MotorInterface::MotorInterface_data_t::vy.


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