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

SetMotorsMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::Roomba500Interface::SetMotorsMessage:

Public Member Functions

 SetMotorsMessage (const bool ini_vacuuming, const BrushState ini_main, const BrushState ini_side)
 Constructor with initial values. More...
 
 SetMotorsMessage ()
 Constructor. More...
 
 ~SetMotorsMessage ()
 Destructor. More...
 
 SetMotorsMessage (const SetMotorsMessage *m)
 Copy constructor. More...
 
bool is_vacuuming () const
 Get vacuuming value. More...
 
void set_vacuuming (const bool new_vacuuming)
 Set vacuuming value. More...
 
size_t maxlenof_vacuuming () const
 Get maximum length of vacuuming value. More...
 
BrushState main () const
 Get main value. More...
 
void set_main (const BrushState new_main)
 Set main value. More...
 
size_t maxlenof_main () const
 Get maximum length of main value. More...
 
BrushState side () const
 Get side value. More...
 
void set_side (const BrushState new_side)
 Set side value. More...
 
size_t maxlenof_side () const
 Get maximum length of side 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

Constructor & Destructor Documentation

◆ SetMotorsMessage() [1/3]

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage ( const bool  ini_vacuuming,
const BrushState  ini_main,
const BrushState  ini_side 
)

Constructor with initial values.

Parameters
ini_vacuuminginitial value for vacuuming
ini_maininitial value for main
ini_sideinitial value for side

Definition at line 3201 of file Roomba500Interface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Roomba500Interface::BRUSHSTATE_BACKWARD, fawkes::Roomba500Interface::BRUSHSTATE_FORWARD, fawkes::Roomba500Interface::BRUSHSTATE_OFF, fawkes::Roomba500Interface::CHARGING_ERROR, fawkes::Roomba500Interface::CHARGING_FULL, fawkes::Roomba500Interface::CHARGING_NO, fawkes::Roomba500Interface::CHARGING_RECONDITIONING, fawkes::Roomba500Interface::CHARGING_TRICKLE, fawkes::Roomba500Interface::CHARGING_WAITING, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, fawkes::IFT_ENUM, fawkes::Roomba500Interface::IR_DISC_DOCK_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_GREEN_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_GREEN_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RESERVED, fawkes::Roomba500Interface::IR_DOCK_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_GREEN_BUOY, fawkes::Roomba500Interface::IR_DOCK_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RED_BUOY, fawkes::Roomba500Interface::IR_DOCK_RED_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RED_GREEN_BUOY, fawkes::Roomba500Interface::IR_DOCK_RED_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RESERVED, fawkes::Roomba500Interface::IR_NONE, fawkes::Roomba500Interface::IR_REMOTE_ARC_LEFT, fawkes::Roomba500Interface::IR_REMOTE_ARC_RIGHT, fawkes::Roomba500Interface::IR_REMOTE_FORWARD, fawkes::Roomba500Interface::IR_REMOTE_LARGE_CLEAN, fawkes::Roomba500Interface::IR_REMOTE_LEFT, fawkes::Roomba500Interface::IR_REMOTE_MAX, fawkes::Roomba500Interface::IR_REMOTE_MEDIUM, fawkes::Roomba500Interface::IR_REMOTE_POWER, fawkes::Roomba500Interface::IR_REMOTE_RIGHT, fawkes::Roomba500Interface::IR_REMOTE_SMALL, fawkes::Roomba500Interface::IR_REMOTE_SPOT, fawkes::Roomba500Interface::IR_REMOTE_STOP, fawkes::Roomba500Interface::IR_REMOTE_STOP2, fawkes::Roomba500Interface::IR_SCHED_REMOTE_DOWNLOAD, fawkes::Roomba500Interface::IR_SCHED_REMOTE_SEEK_DOCK, fawkes::Roomba500Interface::IR_VIRTUAL_WALL, fawkes::Roomba500Interface::MODE_FULL, fawkes::Roomba500Interface::MODE_OFF, fawkes::Roomba500Interface::MODE_PASSIVE, and fawkes::Roomba500Interface::MODE_SAFE.

◆ SetMotorsMessage() [2/3]

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage ( )

Constructor.

Definition at line 3262 of file Roomba500Interface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Roomba500Interface::BRUSHSTATE_BACKWARD, fawkes::Roomba500Interface::BRUSHSTATE_FORWARD, fawkes::Roomba500Interface::BRUSHSTATE_OFF, fawkes::Roomba500Interface::CHARGING_ERROR, fawkes::Roomba500Interface::CHARGING_FULL, fawkes::Roomba500Interface::CHARGING_NO, fawkes::Roomba500Interface::CHARGING_RECONDITIONING, fawkes::Roomba500Interface::CHARGING_TRICKLE, fawkes::Roomba500Interface::CHARGING_WAITING, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BOOL, fawkes::IFT_ENUM, fawkes::Roomba500Interface::IR_DISC_DOCK_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_GREEN_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_GREEN_BUOY, fawkes::Roomba500Interface::IR_DISC_DOCK_RED_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DISC_DOCK_RESERVED, fawkes::Roomba500Interface::IR_DOCK_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_GREEN_BUOY, fawkes::Roomba500Interface::IR_DOCK_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RED_BUOY, fawkes::Roomba500Interface::IR_DOCK_RED_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RED_GREEN_BUOY, fawkes::Roomba500Interface::IR_DOCK_RED_GREEN_BUOY_FORCE_FIELD, fawkes::Roomba500Interface::IR_DOCK_RESERVED, fawkes::Roomba500Interface::IR_NONE, fawkes::Roomba500Interface::IR_REMOTE_ARC_LEFT, fawkes::Roomba500Interface::IR_REMOTE_ARC_RIGHT, fawkes::Roomba500Interface::IR_REMOTE_FORWARD, fawkes::Roomba500Interface::IR_REMOTE_LARGE_CLEAN, fawkes::Roomba500Interface::IR_REMOTE_LEFT, fawkes::Roomba500Interface::IR_REMOTE_MAX, fawkes::Roomba500Interface::IR_REMOTE_MEDIUM, fawkes::Roomba500Interface::IR_REMOTE_POWER, fawkes::Roomba500Interface::IR_REMOTE_RIGHT, fawkes::Roomba500Interface::IR_REMOTE_SMALL, fawkes::Roomba500Interface::IR_REMOTE_SPOT, fawkes::Roomba500Interface::IR_REMOTE_STOP, fawkes::Roomba500Interface::IR_REMOTE_STOP2, fawkes::Roomba500Interface::IR_SCHED_REMOTE_DOWNLOAD, fawkes::Roomba500Interface::IR_SCHED_REMOTE_SEEK_DOCK, fawkes::Roomba500Interface::IR_VIRTUAL_WALL, fawkes::Roomba500Interface::MODE_FULL, fawkes::Roomba500Interface::MODE_OFF, fawkes::Roomba500Interface::MODE_PASSIVE, and fawkes::Roomba500Interface::MODE_SAFE.

◆ ~SetMotorsMessage()

fawkes::Roomba500Interface::SetMotorsMessage::~SetMotorsMessage ( )

Destructor.

Definition at line 3321 of file Roomba500Interface.cpp.

References fawkes::Message::data_ptr.

◆ SetMotorsMessage() [3/3]

fawkes::Roomba500Interface::SetMotorsMessage::SetMotorsMessage ( const SetMotorsMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 3329 of file Roomba500Interface.cpp.

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

Member Function Documentation

◆ clone()

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

◆ is_vacuuming()

bool fawkes::Roomba500Interface::SetMotorsMessage::is_vacuuming ( ) const

Get vacuuming value.

Enable vacuuming?

Returns
vacuuming value

Definition at line 3344 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().

◆ main()

Roomba500Interface::BrushState fawkes::Roomba500Interface::SetMotorsMessage::main ( ) const

Get main value.

Main brush state.

Returns
main value

Definition at line 3374 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().

◆ maxlenof_main()

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_main ( ) const

Get maximum length of main value.

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

Definition at line 3384 of file Roomba500Interface.cpp.

◆ maxlenof_side()

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_side ( ) const

Get maximum length of side value.

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

Definition at line 3414 of file Roomba500Interface.cpp.

◆ maxlenof_vacuuming()

size_t fawkes::Roomba500Interface::SetMotorsMessage::maxlenof_vacuuming ( ) const

Get maximum length of vacuuming value.

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

Definition at line 3354 of file Roomba500Interface.cpp.

◆ set_main()

void fawkes::Roomba500Interface::SetMotorsMessage::set_main ( const BrushState  new_main)

Set main value.

Main brush state.

Parameters
new_mainnew main value

Definition at line 3394 of file Roomba500Interface.cpp.

◆ set_side()

void fawkes::Roomba500Interface::SetMotorsMessage::set_side ( const BrushState  new_side)

Set side value.

Side brush state.

Parameters
new_sidenew side value

Definition at line 3424 of file Roomba500Interface.cpp.

◆ set_vacuuming()

void fawkes::Roomba500Interface::SetMotorsMessage::set_vacuuming ( const bool  new_vacuuming)

Set vacuuming value.

Enable vacuuming?

Parameters
new_vacuumingnew vacuuming value

Definition at line 3364 of file Roomba500Interface.cpp.

◆ side()

Roomba500Interface::BrushState fawkes::Roomba500Interface::SetMotorsMessage::side ( ) const

Get side value.

Side brush state.

Returns
side value

Definition at line 3404 of file Roomba500Interface.cpp.

Referenced by Roomba500Thread::loop().


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