Fawkes API
Fawkes Development Version
|
DeleteObjectMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
DeleteObjectMessage (const uint32_t ini_object_id) | |
Constructor with initial values. More... | |
DeleteObjectMessage () | |
Constructor. More... | |
~DeleteObjectMessage () | |
Destructor. More... | |
DeleteObjectMessage (const DeleteObjectMessage *m) | |
Copy constructor. More... | |
uint32_t | object_id () const |
Get object_id value. More... | |
void | set_object_id (const uint32_t new_object_id) |
Set object_id value. More... | |
size_t | maxlenof_object_id () const |
Get maximum length of object_id value. 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... | |
DeleteObjectMessage Fawkes BlackBoard Interface Message.
Definition at line 275 of file VisualDisplay2DInterface.h.
fawkes::VisualDisplay2DInterface::DeleteObjectMessage::DeleteObjectMessage | ( | const uint32_t | ini_object_id | ) |
Constructor with initial values.
ini_object_id | initial value for object_id |
Definition at line 1438 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::VisualDisplay2DInterface::CENTERED, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::VisualDisplay2DInterface::EAST, fawkes::IFT_UINT32, fawkes::VisualDisplay2DInterface::LS_DASH_DOTTED, fawkes::VisualDisplay2DInterface::LS_DASHED, fawkes::VisualDisplay2DInterface::LS_DOTTED, fawkes::VisualDisplay2DInterface::LS_SOLID, fawkes::VisualDisplay2DInterface::NORTH, fawkes::VisualDisplay2DInterface::NORTH_EAST, fawkes::VisualDisplay2DInterface::NORTH_WEST, fawkes::VisualDisplay2DInterface::SOUTH, fawkes::VisualDisplay2DInterface::SOUTH_EAST, fawkes::VisualDisplay2DInterface::SOUTH_WEST, and fawkes::VisualDisplay2DInterface::WEST.
fawkes::VisualDisplay2DInterface::DeleteObjectMessage::DeleteObjectMessage | ( | ) |
Constructor.
Definition at line 1462 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::VisualDisplay2DInterface::CENTERED, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::VisualDisplay2DInterface::EAST, fawkes::IFT_UINT32, fawkes::VisualDisplay2DInterface::LS_DASH_DOTTED, fawkes::VisualDisplay2DInterface::LS_DASHED, fawkes::VisualDisplay2DInterface::LS_DOTTED, fawkes::VisualDisplay2DInterface::LS_SOLID, fawkes::VisualDisplay2DInterface::NORTH, fawkes::VisualDisplay2DInterface::NORTH_EAST, fawkes::VisualDisplay2DInterface::NORTH_WEST, fawkes::VisualDisplay2DInterface::SOUTH, fawkes::VisualDisplay2DInterface::SOUTH_EAST, fawkes::VisualDisplay2DInterface::SOUTH_WEST, and fawkes::VisualDisplay2DInterface::WEST.
fawkes::VisualDisplay2DInterface::DeleteObjectMessage::~DeleteObjectMessage | ( | ) |
Destructor.
Definition at line 1486 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::VisualDisplay2DInterface::DeleteObjectMessage::DeleteObjectMessage | ( | const DeleteObjectMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 1494 of file VisualDisplay2DInterface.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 1542 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::DeleteObjectMessage::maxlenof_object_id | ( | ) | const |
Get maximum length of object_id value.
Definition at line 1520 of file VisualDisplay2DInterface.cpp.
uint32_t fawkes::VisualDisplay2DInterface::DeleteObjectMessage::object_id | ( | ) | const |
Get object_id value.
Object ID, which is the message ID of the Add* message.
Definition at line 1510 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::DeleteObjectMessage::set_object_id | ( | const uint32_t | new_object_id | ) |
Set object_id value.
Object ID, which is the message ID of the Add* message.
new_object_id | new object_id value |
Definition at line 1531 of file VisualDisplay2DInterface.cpp.