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

DriveStraightMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::DriveStraightMessage:

List of all members.

Classes

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

Public Member Functions

 DriveStraightMessage (const int16_t ini_velocity)
 Constructor with initial values.
 DriveStraightMessage ()
 Constructor.
 ~DriveStraightMessage ()
 Destructor.
 DriveStraightMessage (const DriveStraightMessage *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.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::Roomba500Interface::DriveStraightMessage::DriveStraightMessage ( const int16_t  ini_velocity)
fawkes::Roomba500Interface::DriveStraightMessage::~DriveStraightMessage ( )

Destructor.

Definition at line 2591 of file Roomba500Interface.cpp.

References fawkes::Interface::data_ptr.

fawkes::Roomba500Interface::DriveStraightMessage::DriveStraightMessage ( const DriveStraightMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2599 of file Roomba500Interface.cpp.

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


Member Function Documentation

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

size_t fawkes::Roomba500Interface::DriveStraightMessage::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 2624 of file Roomba500Interface.cpp.

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

Set velocity value.

Requested velocity in mm/s.

Parameters:
new_velocitynew velocity value

Definition at line 2634 of file Roomba500Interface.cpp.

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

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

Get velocity value.

Requested velocity in mm/s.

Returns:
velocity value

Definition at line 2614 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: