Fawkes API  Fawkes Development Version
fawkes::OpenRaveInterface::AttachObjectMessage Class Reference

AttachObjectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::OpenRaveInterface::AttachObjectMessage:

Public Member Functions

 AttachObjectMessage (const char *ini_name, const char *ini_manip_name)
 Constructor with initial values. More...
 
 AttachObjectMessage ()
 Constructor. More...
 
 ~AttachObjectMessage ()
 Destructor. More...
 
 AttachObjectMessage (const AttachObjectMessage *m)
 Copy constructor. More...
 
char * name () const
 Get name value. More...
 
void set_name (const char *new_name)
 Set name value. More...
 
size_t maxlenof_name () const
 Get maximum length of name value. More...
 
char * manip_name () const
 Get manip_name value. More...
 
void set_manip_name (const char *new_manip_name)
 Set manip_name value. More...
 
size_t maxlenof_manip_name () const
 Get maximum length of manip_name 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

◆ AttachObjectMessage() [1/3]

fawkes::OpenRaveInterface::AttachObjectMessage::AttachObjectMessage ( const char *  ini_name,
const char *  ini_manip_name 
)

Constructor with initial values.

Parameters
ini_nameinitial value for name
ini_manip_nameinitial value for manip_name

Definition at line 582 of file OpenRaveInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_STRING.

◆ AttachObjectMessage() [2/3]

fawkes::OpenRaveInterface::AttachObjectMessage::AttachObjectMessage ( )

◆ ~AttachObjectMessage()

fawkes::OpenRaveInterface::AttachObjectMessage::~AttachObjectMessage ( )

Destructor.

Definition at line 607 of file OpenRaveInterface.cpp.

References fawkes::Message::data_ptr.

◆ AttachObjectMessage() [3/3]

fawkes::OpenRaveInterface::AttachObjectMessage::AttachObjectMessage ( const AttachObjectMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 615 of file OpenRaveInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::OpenRaveInterface::AttachObjectMessage::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 691 of file OpenRaveInterface.cpp.

◆ manip_name()

char * fawkes::OpenRaveInterface::AttachObjectMessage::manip_name ( ) const

Get manip_name value.

Name of manipulator

Returns
manip_name value

Definition at line 660 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

◆ maxlenof_manip_name()

size_t fawkes::OpenRaveInterface::AttachObjectMessage::maxlenof_manip_name ( ) const

Get maximum length of manip_name value.

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

Definition at line 670 of file OpenRaveInterface.cpp.

◆ maxlenof_name()

size_t fawkes::OpenRaveInterface::AttachObjectMessage::maxlenof_name ( ) const

Get maximum length of name value.

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

Definition at line 640 of file OpenRaveInterface.cpp.

◆ name()

char * fawkes::OpenRaveInterface::AttachObjectMessage::name ( ) const

Get name value.

Name of object

Returns
name value

Definition at line 630 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

◆ set_manip_name()

void fawkes::OpenRaveInterface::AttachObjectMessage::set_manip_name ( const char *  new_manip_name)

Set manip_name value.

Name of manipulator

Parameters
new_manip_namenew manip_name value

Definition at line 680 of file OpenRaveInterface.cpp.

◆ set_name()

void fawkes::OpenRaveInterface::AttachObjectMessage::set_name ( const char *  new_name)

Set name value.

Name of object

Parameters
new_namenew name value

Definition at line 650 of file OpenRaveInterface.cpp.


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