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

DriveRPMMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::DriveRPMMessage:

Public Member Functions

 DriveRPMMessage (const float ini_front_right, const float ini_front_left, const float ini_rear)
 Constructor with initial values. More...
 
 DriveRPMMessage ()
 Constructor. More...
 
 ~DriveRPMMessage ()
 Destructor. More...
 
 DriveRPMMessage (const DriveRPMMessage *m)
 Copy constructor. More...
 
float front_right () const
 Get front_right value. More...
 
void set_front_right (const float new_front_right)
 Set front_right value. More...
 
size_t maxlenof_front_right () const
 Get maximum length of front_right value. More...
 
float front_left () const
 Get front_left value. More...
 
void set_front_left (const float new_front_left)
 Set front_left value. More...
 
size_t maxlenof_front_left () const
 Get maximum length of front_left value. More...
 
float rear () const
 Get rear value. More...
 
void set_rear (const float new_rear)
 Set rear value. More...
 
size_t maxlenof_rear () const
 Get maximum length of rear value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

DriveRPMMessage Fawkes BlackBoard Interface Message.

Definition at line 230 of file MotorInterface.h.

Constructor & Destructor Documentation

◆ DriveRPMMessage() [1/3]

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 1210 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.

◆ DriveRPMMessage() [2/3]

fawkes::MotorInterface::DriveRPMMessage::DriveRPMMessage ( )

◆ ~DriveRPMMessage()

fawkes::MotorInterface::DriveRPMMessage::~DriveRPMMessage ( )

Destructor.

Definition at line 1238 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

◆ DriveRPMMessage() [3/3]

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

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1246 of file MotorInterface.cpp.

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

Member Function Documentation

◆ clone()

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

◆ front_left()

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

◆ front_right()

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

◆ maxlenof_front_left()

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

◆ maxlenof_front_right()

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

◆ maxlenof_rear()

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

◆ rear()

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

Get rear value.

Rotation in RPM of the rear wheel.

Returns
rear value

Definition at line 1321 of file MotorInterface.cpp.

◆ set_front_left()

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

◆ set_front_right()

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

◆ set_rear()

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


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