Fawkes API Fawkes Development Version

fawkes::MotorInterface::DriveRPMMessage Class Reference

DriveRPMMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::DriveRPMMessage:

List of all members.

Classes

struct  DriveRPMMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 DriveRPMMessage (const float ini_front_right, const float ini_front_left, const float ini_rear)
 Constructor with initial values.
 DriveRPMMessage ()
 Constructor.
 ~DriveRPMMessage ()
 Destructor.
 DriveRPMMessage (const DriveRPMMessage *m)
 Copy constructor.
float front_right () const
 Get front_right value.
void set_front_right (const float new_front_right)
 Set front_right value.
size_t maxlenof_front_right () const
 Get maximum length of front_right value.
float front_left () const
 Get front_left value.
void set_front_left (const float new_front_left)
 Set front_left value.
size_t maxlenof_front_left () const
 Get maximum length of front_left value.
float rear () const
 Get rear value.
void set_rear (const float new_rear)
 Set rear value.
size_t maxlenof_rear () const
 Get maximum length of rear value.
virtual Messageclone () const
 Clone this message.

Detailed Description

DriveRPMMessage Fawkes BlackBoard Interface Message.

Definition at line 196 of file MotorInterface.h.


Constructor & Destructor Documentation

fawkes::MotorInterface::DriveRPMMessage::DriveRPMMessage ( const float  ini_front_right,
const float  ini_front_left,
const float  ini_rear 
)

Constructor with initial values.

Parameters:
ini_front_rightinitial value for front_right
ini_front_leftinitial value for front_left
ini_rearinitial value for rear

Definition at line 939 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::DriveRPMMessage::DriveRPMMessage ( )
fawkes::MotorInterface::DriveRPMMessage::~DriveRPMMessage ( )

Destructor.

Definition at line 967 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::MotorInterface::DriveRPMMessage::DriveRPMMessage ( const DriveRPMMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 975 of file MotorInterface.cpp.

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


Member Function Documentation

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

float fawkes::MotorInterface::DriveRPMMessage::front_left ( ) const

Get front_left value.

Rotation in RPM of the left front wheel.

Returns:
front_left value

Definition at line 1020 of file MotorInterface.cpp.

float fawkes::MotorInterface::DriveRPMMessage::front_right ( ) const

Get front_right value.

Rotation in RPM of the right front wheel.

Returns:
front_right value

Definition at line 990 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_front_left ( ) const

Get maximum length of front_left value.

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

Definition at line 1030 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_front_right ( ) const

Get maximum length of front_right value.

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

Definition at line 1000 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_rear ( ) const

Get maximum length of rear value.

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

Definition at line 1060 of file MotorInterface.cpp.

float fawkes::MotorInterface::DriveRPMMessage::rear ( ) const

Get rear value.

Rotation in RPM of the rear wheel.

Returns:
rear value

Definition at line 1050 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_front_left ( const float  new_front_left)

Set front_left value.

Rotation in RPM of the left front wheel.

Parameters:
new_front_leftnew front_left value

Definition at line 1040 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_front_right ( const float  new_front_right)

Set front_right value.

Rotation in RPM of the right front wheel.

Parameters:
new_front_rightnew front_right value

Definition at line 1010 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_rear ( const float  new_rear)

Set rear value.

Rotation in RPM of the rear wheel.

Parameters:
new_rearnew rear value

Definition at line 1070 of file MotorInterface.cpp.


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