Fawkes API  Fawkes Development Version
fawkes::VisualDisplay2DInterface::DeleteObjectMessage Class Reference

DeleteObjectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::VisualDisplay2DInterface::DeleteObjectMessage:

List of all members.

Classes

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

Public Member Functions

 DeleteObjectMessage (const uint32_t ini_object_id)
 Constructor with initial values.
 DeleteObjectMessage ()
 Constructor.
 ~DeleteObjectMessage ()
 Destructor.
 DeleteObjectMessage (const DeleteObjectMessage *m)
 Copy constructor.
uint32_t object_id () const
 Get object_id value.
void set_object_id (const uint32_t new_object_id)
 Set object_id value.
size_t maxlenof_object_id () const
 Get maximum length of object_id value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::VisualDisplay2DInterface::DeleteObjectMessage::DeleteObjectMessage ( const uint32_t  ini_object_id)
fawkes::VisualDisplay2DInterface::DeleteObjectMessage::~DeleteObjectMessage ( )

Destructor.

Definition at line 1341 of file VisualDisplay2DInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::VisualDisplay2DInterface::DeleteObjectMessage::DeleteObjectMessage ( const DeleteObjectMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1349 of file VisualDisplay2DInterface.cpp.

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


Member Function Documentation

Message * fawkes::VisualDisplay2DInterface::DeleteObjectMessage::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 1397 of file VisualDisplay2DInterface.cpp.

size_t fawkes::VisualDisplay2DInterface::DeleteObjectMessage::maxlenof_object_id ( ) const

Get maximum length of object_id value.

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

Definition at line 1375 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.

Returns:
object_id value

Definition at line 1365 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.

Parameters:
new_object_idnew object_id value

Definition at line 1386 of file VisualDisplay2DInterface.cpp.


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