Fawkes API  Fawkes Development Version
fawkes::Roomba500Interface::DriveMessage Class Reference

DriveMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::DriveMessage:

List of all members.

Classes

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

Public Member Functions

 DriveMessage (const int16_t ini_velocity, const int16_t ini_radius)
 Constructor with initial values.
 DriveMessage ()
 Constructor.
 ~DriveMessage ()
 Destructor.
 DriveMessage (const DriveMessage *m)
 Copy constructor.
int16_t velocity () const
 Get velocity value.
void set_velocity (const int16_t new_velocity)
 Set velocity value.
size_t maxlenof_velocity () const
 Get maximum length of velocity value.
int16_t radius () const
 Get radius value.
void set_radius (const int16_t new_radius)
 Set radius value.
size_t maxlenof_radius () const
 Get maximum length of radius value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::Roomba500Interface::DriveMessage::DriveMessage ( const int16_t  ini_velocity,
const int16_t  ini_radius 
)
fawkes::Roomba500Interface::DriveMessage::~DriveMessage ( )

Destructor.

Definition at line 2685 of file Roomba500Interface.cpp.

References fawkes::Interface::data_ptr.

fawkes::Roomba500Interface::DriveMessage::DriveMessage ( const DriveMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2693 of file Roomba500Interface.cpp.

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


Member Function Documentation

Message * fawkes::Roomba500Interface::DriveMessage::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 2769 of file Roomba500Interface.cpp.

size_t fawkes::Roomba500Interface::DriveMessage::maxlenof_radius ( ) const

Get maximum length of radius value.

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

Definition at line 2748 of file Roomba500Interface.cpp.

size_t fawkes::Roomba500Interface::DriveMessage::maxlenof_velocity ( ) const

Get maximum length of velocity value.

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

Definition at line 2718 of file Roomba500Interface.cpp.

int16_t fawkes::Roomba500Interface::DriveMessage::radius ( ) const

Get radius value.

Requested radius in mm.

Returns:
radius value

Definition at line 2738 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::radius.

Referenced by Roomba500Thread::loop().

void fawkes::Roomba500Interface::DriveMessage::set_radius ( const int16_t  new_radius)

Set radius value.

Requested radius in mm.

Parameters:
new_radiusnew radius value

Definition at line 2758 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::radius.

void fawkes::Roomba500Interface::DriveMessage::set_velocity ( const int16_t  new_velocity)

Set velocity value.

Requested velocity in mm/s.

Parameters:
new_velocitynew velocity value

Definition at line 2728 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::velocity.

int16_t fawkes::Roomba500Interface::DriveMessage::velocity ( ) const

Get velocity value.

Requested velocity in mm/s.

Returns:
velocity value

Definition at line 2708 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::velocity.

Referenced by Roomba500Thread::loop().


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