fawkes::MotorInterface::LinTransRotMessage Class Reference

LinTransRotMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::LinTransRotMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  LinTransRotMessage_data_t
 Internal data storage, do NOT modify!

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 Message * clone () const
 Clone this message.

Detailed Description

LinTransRotMessage Fawkes BlackBoard Interface Message.

Definition at line 351 of file MotorInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

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

Definition at line 1767 of file MotorInterface.cpp.

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

fawkes::MotorInterface::LinTransRotMessage::LinTransRotMessage (  ) 

Constructor.

Definition at line 1781 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::LinTransRotMessage::~LinTransRotMessage (  ) 

Destructor.

Definition at line 1793 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 1801 of file MotorInterface.cpp.

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

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 1906 of file MotorInterface.cpp.

References LinTransRotMessage().

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 1885 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 1825 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 1855 of file MotorInterface.cpp.

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

Get omega value.

Rotational speed in rad/s.

Returns:
omega value

Definition at line 1875 of file MotorInterface.cpp.

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

Set omega value.

Rotational speed in rad/s.

Parameters:
new_omega new omega value

Definition at line 1895 of file MotorInterface.cpp.

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

Set vx value.

Speed for translation in X direction in m/s.

Parameters:
new_vx new vx value

Definition at line 1835 of file MotorInterface.cpp.

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

Set vy value.

Speed for translation in Y direction in m/s.

Parameters:
new_vy new vy value

Definition at line 1865 of file MotorInterface.cpp.

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

Get vx value.

Speed for translation in X direction in m/s.

Returns:
vx value

Definition at line 1815 of file MotorInterface.cpp.

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

Get vy value.

Speed for translation in Y direction in m/s.

Returns:
vy value

Definition at line 1845 of file MotorInterface.cpp.

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