Fawkes API
Fawkes Development Version
|
DockMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
DockMessage () | |
Constructor. More... | |
~DockMessage () | |
Destructor. More... | |
DockMessage (const DockMessage *m) | |
Copy constructor. More... | |
virtual Message * | clone () const |
Clone this message. More... | |
![]() | |
Message (const char *type) | |
Constructor. More... | |
Message (const Message *mesg) | |
Copy constructor. More... | |
Message (const Message &mesg) | |
Copy constructor. More... | |
virtual | ~Message () |
Destructor. More... | |
Message & | operator= (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 Time * | time_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... | |
Interface * | interface () 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... | |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
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_t * | data_ts |
data timestamp aliasing pointer More... | |
DockMessage Fawkes BlackBoard Interface Message.
Definition at line 247 of file Roomba500Interface.h.
fawkes::Roomba500Interface::DockMessage::DockMessage | ( | ) |
Constructor.
Definition at line 2525 of file Roomba500Interface.cpp.
References 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::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.
fawkes::Roomba500Interface::DockMessage::~DockMessage | ( | ) |
Destructor.
Definition at line 2581 of file Roomba500Interface.cpp.
References fawkes::Message::data_ptr.
fawkes::Roomba500Interface::DockMessage::DockMessage | ( | const DockMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 2589 of file Roomba500Interface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
|
virtual |
Clone this message.
Produces a message of the same type as this message and copies the data to the new message.
Reimplemented from fawkes::Message.
Definition at line 2605 of file Roomba500Interface.cpp.