Fawkes API Fawkes Development Version

fawkes::MotorInterface::OrbitMessage Class Reference

OrbitMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::OrbitMessage:

List of all members.

Classes

struct  OrbitMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 OrbitMessage (const float ini_px, const float ini_py, const float ini_omega)
 Constructor with initial values.
 OrbitMessage ()
 Constructor.
 ~OrbitMessage ()
 Destructor.
 OrbitMessage (const OrbitMessage *m)
 Copy constructor.
float px () const
 Get px value.
void set_px (const float new_px)
 Set px value.
size_t maxlenof_px () const
 Get maximum length of px value.
float py () const
 Get py value.
void set_py (const float new_py)
 Set py value.
size_t maxlenof_py () const
 Get maximum length of py 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

OrbitMessage Fawkes BlackBoard Interface Message.

Definition at line 363 of file MotorInterface.h.


Constructor & Destructor Documentation

fawkes::MotorInterface::OrbitMessage::OrbitMessage ( const float  ini_px,
const float  ini_py,
const float  ini_omega 
)

Constructor with initial values.

Parameters:
ini_pxinitial value for px
ini_pyinitial value for py
ini_omegainitial value for omega

Definition at line 1661 of file MotorInterface.cpp.

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

fawkes::MotorInterface::OrbitMessage::OrbitMessage ( )
fawkes::MotorInterface::OrbitMessage::~OrbitMessage ( )

Destructor.

Definition at line 1689 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::MotorInterface::OrbitMessage::OrbitMessage ( const OrbitMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1697 of file MotorInterface.cpp.

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


Member Function Documentation

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

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

size_t fawkes::MotorInterface::OrbitMessage::maxlenof_px ( ) const

Get maximum length of px value.

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

Definition at line 1722 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::OrbitMessage::maxlenof_py ( ) const

Get maximum length of py value.

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

Definition at line 1752 of file MotorInterface.cpp.

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

Get omega value.

Angular speed around point in rad/s.

Returns:
omega value

Definition at line 1772 of file MotorInterface.cpp.

float fawkes::MotorInterface::OrbitMessage::px ( ) const

Get px value.

Point's X coordinate to orbit.

Returns:
px value

Definition at line 1712 of file MotorInterface.cpp.

float fawkes::MotorInterface::OrbitMessage::py ( ) const

Get py value.

Point's Y coordinate to orbit.

Returns:
py value

Definition at line 1742 of file MotorInterface.cpp.

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

Set omega value.

Angular speed around point in rad/s.

Parameters:
new_omeganew omega value

Definition at line 1792 of file MotorInterface.cpp.

void fawkes::MotorInterface::OrbitMessage::set_px ( const float  new_px)

Set px value.

Point's X coordinate to orbit.

Parameters:
new_pxnew px value

Definition at line 1732 of file MotorInterface.cpp.

void fawkes::MotorInterface::OrbitMessage::set_py ( const float  new_py)

Set py value.

Point's Y coordinate to orbit.

Parameters:
new_pynew py value

Definition at line 1762 of file MotorInterface.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends