Fawkes API  Fawkes Development Version
fawkes::PclDatabaseStoreInterface::StoreMessage Class Reference

StoreMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PclDatabaseStoreInterface::StoreMessage:

Public Member Functions

 StoreMessage (const char *ini_pcl_id, const char *ini_database, const char *ini_collection)
 Constructor with initial values. More...
 
 StoreMessage ()
 Constructor. More...
 
 ~StoreMessage ()
 Destructor. More...
 
 StoreMessage (const StoreMessage *m)
 Copy constructor. More...
 
char * pcl_id () const
 Get pcl_id value. More...
 
void set_pcl_id (const char *new_pcl_id)
 Set pcl_id value. More...
 
size_t maxlenof_pcl_id () const
 Get maximum length of pcl_id value. More...
 
char * database () const
 Get database value. More...
 
void set_database (const char *new_database)
 Set database value. More...
 
size_t maxlenof_database () const
 Get maximum length of database value. More...
 
char * collection () const
 Get collection value. More...
 
void set_collection (const char *new_collection)
 Set collection value. More...
 
size_t maxlenof_collection () const
 Get maximum length of collection 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

◆ StoreMessage() [1/3]

fawkes::PclDatabaseStoreInterface::StoreMessage::StoreMessage ( const char *  ini_pcl_id,
const char *  ini_database,
const char *  ini_collection 
)

Constructor with initial values.

Parameters
ini_pcl_idinitial value for pcl_id
ini_databaseinitial value for database
ini_collectioninitial value for collection

Definition at line 222 of file PclDatabaseStoreInterface.cpp.

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

◆ StoreMessage() [2/3]

fawkes::PclDatabaseStoreInterface::StoreMessage::StoreMessage ( )

◆ ~StoreMessage()

fawkes::PclDatabaseStoreInterface::StoreMessage::~StoreMessage ( )

Destructor.

Definition at line 250 of file PclDatabaseStoreInterface.cpp.

References fawkes::Message::data_ptr.

◆ StoreMessage() [3/3]

fawkes::PclDatabaseStoreInterface::StoreMessage::StoreMessage ( const StoreMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 258 of file PclDatabaseStoreInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::PclDatabaseStoreInterface::StoreMessage::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 380 of file PclDatabaseStoreInterface.cpp.

◆ collection()

char * fawkes::PclDatabaseStoreInterface::StoreMessage::collection ( ) const

Get collection value.

Collection name from which to read the point clouds. May NOT include the database name.

Returns
collection value

Definition at line 346 of file PclDatabaseStoreInterface.cpp.

◆ database()

char * fawkes::PclDatabaseStoreInterface::StoreMessage::database ( ) const

Get database value.

Database name from which to read the point clouds. If empty will use plugin-configured default.

Returns
database value

Definition at line 310 of file PclDatabaseStoreInterface.cpp.

◆ maxlenof_collection()

size_t fawkes::PclDatabaseStoreInterface::StoreMessage::maxlenof_collection ( ) const

Get maximum length of collection value.

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

Definition at line 356 of file PclDatabaseStoreInterface.cpp.

◆ maxlenof_database()

size_t fawkes::PclDatabaseStoreInterface::StoreMessage::maxlenof_database ( ) const

Get maximum length of database value.

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

Definition at line 320 of file PclDatabaseStoreInterface.cpp.

◆ maxlenof_pcl_id()

size_t fawkes::PclDatabaseStoreInterface::StoreMessage::maxlenof_pcl_id ( ) const

Get maximum length of pcl_id value.

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

Definition at line 285 of file PclDatabaseStoreInterface.cpp.

◆ pcl_id()

char * fawkes::PclDatabaseStoreInterface::StoreMessage::pcl_id ( ) const

Get pcl_id value.

ID of the point cloud to store.

Returns
pcl_id value

Definition at line 275 of file PclDatabaseStoreInterface.cpp.

◆ set_collection()

void fawkes::PclDatabaseStoreInterface::StoreMessage::set_collection ( const char *  new_collection)

Set collection value.

Collection name from which to read the point clouds. May NOT include the database name.

Parameters
new_collectionnew collection value

Definition at line 369 of file PclDatabaseStoreInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_database()

void fawkes::PclDatabaseStoreInterface::StoreMessage::set_database ( const char *  new_database)

Set database value.

Database name from which to read the point clouds. If empty will use plugin-configured default.

Parameters
new_databasenew database value

Definition at line 333 of file PclDatabaseStoreInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_pcl_id()

void fawkes::PclDatabaseStoreInterface::StoreMessage::set_pcl_id ( const char *  new_pcl_id)

Set pcl_id value.

ID of the point cloud to store.

Parameters
new_pcl_idnew pcl_id value

Definition at line 297 of file PclDatabaseStoreInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().


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