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

SetModeMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::SetModeMessage:

List of all members.

Classes

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

Public Member Functions

 SetModeMessage (const Mode ini_mode)
 Constructor with initial values.
 SetModeMessage ()
 Constructor.
 ~SetModeMessage ()
 Destructor.
 SetModeMessage (const SetModeMessage *m)
 Copy constructor.
Mode mode () const
 Get mode value.
void set_mode (const Mode new_mode)
 Set mode value.
size_t maxlenof_mode () const
 Get maximum length of mode value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::Roomba500Interface::SetModeMessage::SetModeMessage ( const Mode  ini_mode)
fawkes::Roomba500Interface::SetModeMessage::~SetModeMessage ( )

Destructor.

Definition at line 2501 of file Roomba500Interface.cpp.

References fawkes::Interface::data_ptr.

fawkes::Roomba500Interface::SetModeMessage::SetModeMessage ( const SetModeMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2509 of file Roomba500Interface.cpp.

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


Member Function Documentation

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

size_t fawkes::Roomba500Interface::SetModeMessage::maxlenof_mode ( ) const

Get maximum length of mode value.

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

Definition at line 2534 of file Roomba500Interface.cpp.

Roomba500Interface::Mode fawkes::Roomba500Interface::SetModeMessage::mode ( ) const

Get mode value.

Open Interface mode.

Returns:
mode value

Definition at line 2524 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::mode.

Referenced by Roomba500Thread::loop().

void fawkes::Roomba500Interface::SetModeMessage::set_mode ( const Mode  new_mode)

Set mode value.

Open Interface mode.

Parameters:
new_modenew mode value

Definition at line 2544 of file Roomba500Interface.cpp.

References fawkes::Roomba500Interface::Roomba500Interface_data_t::mode.

Referenced by RoombaJoystickThread::loop().


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