Fawkes API  Fawkes Development Version
fawkes::PclDatabaseMergeInterface::MergeMessage Class Reference

MergeMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PclDatabaseMergeInterface::MergeMessage:

Public Member Functions

 MergeMessage (const int64_t *ini_timestamps, const char *ini_database, const char *ini_collection)
 Constructor with initial values. More...
 
 MergeMessage ()
 Constructor. More...
 
 ~MergeMessage ()
 Destructor. More...
 
 MergeMessage (const MergeMessage *m)
 Copy constructor. More...
 
int64_t * timestamps () const
 Get timestamps value. More...
 
int64_t timestamps (unsigned int index) const
 Get timestamps value at given index. More...
 
void set_timestamps (unsigned int index, const int64_t new_timestamps)
 Set timestamps value at given index. More...
 
void set_timestamps (const int64_t *new_timestamps)
 Set timestamps value. More...
 
size_t maxlenof_timestamps () const
 Get maximum length of timestamps 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

◆ MergeMessage() [1/3]

fawkes::PclDatabaseMergeInterface::MergeMessage::MergeMessage ( const int64_t *  ini_timestamps,
const char *  ini_database,
const char *  ini_collection 
)

Constructor with initial values.

Parameters
ini_timestampsinitial value for timestamps
ini_databaseinitial value for database
ini_collectioninitial value for collection

Definition at line 222 of file PclDatabaseMergeInterface.cpp.

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

◆ MergeMessage() [2/3]

fawkes::PclDatabaseMergeInterface::MergeMessage::MergeMessage ( )

◆ ~MergeMessage()

fawkes::PclDatabaseMergeInterface::MergeMessage::~MergeMessage ( )

Destructor.

Definition at line 250 of file PclDatabaseMergeInterface.cpp.

References fawkes::Message::data_ptr.

◆ MergeMessage() [3/3]

fawkes::PclDatabaseMergeInterface::MergeMessage::MergeMessage ( const MergeMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 258 of file PclDatabaseMergeInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::PclDatabaseMergeInterface::MergeMessage::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 416 of file PclDatabaseMergeInterface.cpp.

◆ collection()

char * fawkes::PclDatabaseMergeInterface::MergeMessage::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 382 of file PclDatabaseMergeInterface.cpp.

◆ database()

char * fawkes::PclDatabaseMergeInterface::MergeMessage::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 346 of file PclDatabaseMergeInterface.cpp.

◆ maxlenof_collection()

size_t fawkes::PclDatabaseMergeInterface::MergeMessage::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 392 of file PclDatabaseMergeInterface.cpp.

◆ maxlenof_database()

size_t fawkes::PclDatabaseMergeInterface::MergeMessage::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 356 of file PclDatabaseMergeInterface.cpp.

◆ maxlenof_timestamps()

size_t fawkes::PclDatabaseMergeInterface::MergeMessage::maxlenof_timestamps ( ) const

Get maximum length of timestamps value.

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

Definition at line 304 of file PclDatabaseMergeInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_collection()

void fawkes::PclDatabaseMergeInterface::MergeMessage::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 405 of file PclDatabaseMergeInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_database()

void fawkes::PclDatabaseMergeInterface::MergeMessage::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 369 of file PclDatabaseMergeInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_timestamps() [1/2]

void fawkes::PclDatabaseMergeInterface::MergeMessage::set_timestamps ( unsigned int  index,
const int64_t  new_timestamps 
)

Set timestamps value at given index.

Timestamps for which to retrieve the most recent point clouds and merge them.

Parameters
new_timestampsnew timestamps value
indexindex for of the value

Definition at line 331 of file PclDatabaseMergeInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_timestamps() [2/2]

void fawkes::PclDatabaseMergeInterface::MergeMessage::set_timestamps ( const int64_t *  new_timestamps)

Set timestamps value.

Timestamps for which to retrieve the most recent point clouds and merge them.

Parameters
new_timestampsnew timestamps value

Definition at line 317 of file PclDatabaseMergeInterface.cpp.

◆ timestamps() [1/2]

int64_t * fawkes::PclDatabaseMergeInterface::MergeMessage::timestamps ( ) const

Get timestamps value.

Timestamps for which to retrieve the most recent point clouds and merge them.

Returns
timestamps value

Definition at line 276 of file PclDatabaseMergeInterface.cpp.

◆ timestamps() [2/2]

int64_t fawkes::PclDatabaseMergeInterface::MergeMessage::timestamps ( unsigned int  index) const

Get timestamps value at given index.

Timestamps for which to retrieve the most recent point clouds and merge them.

Parameters
indexindex of value
Returns
timestamps value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 291 of file PclDatabaseMergeInterface.cpp.


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