Fawkes API  Fawkes Development Version
fawkes::PclDatabaseRetrieveInterface::RetrieveMessage Class Reference

RetrieveMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PclDatabaseRetrieveInterface::RetrieveMessage:

Public Member Functions

 RetrieveMessage (const int64_t ini_timestamp, const char *ini_database, const char *ini_collection, const char *ini_target_frame, const bool ini_original_timestamp)
 Constructor with initial values. More...
 
 RetrieveMessage ()
 Constructor. More...
 
 ~RetrieveMessage ()
 Destructor. More...
 
 RetrieveMessage (const RetrieveMessage *m)
 Copy constructor. More...
 
int64_t timestamp () const
 Get timestamp value. More...
 
void set_timestamp (const int64_t new_timestamp)
 Set timestamp value. More...
 
size_t maxlenof_timestamp () const
 Get maximum length of timestamp 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...
 
char * target_frame () const
 Get target_frame value. More...
 
void set_target_frame (const char *new_target_frame)
 Set target_frame value. More...
 
size_t maxlenof_target_frame () const
 Get maximum length of target_frame value. More...
 
bool is_original_timestamp () const
 Get original_timestamp value. More...
 
void set_original_timestamp (const bool new_original_timestamp)
 Set original_timestamp value. More...
 
size_t maxlenof_original_timestamp () const
 Get maximum length of original_timestamp 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

◆ RetrieveMessage() [1/3]

fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::RetrieveMessage ( const int64_t  ini_timestamp,
const char *  ini_database,
const char *  ini_collection,
const char *  ini_target_frame,
const bool  ini_original_timestamp 
)

Constructor with initial values.

Parameters
ini_timestampinitial value for timestamp
ini_databaseinitial value for database
ini_collectioninitial value for collection
ini_target_frameinitial value for target_frame
ini_original_timestampinitial value for original_timestamp

Definition at line 224 of file PclDatabaseRetrieveInterface.cpp.

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

◆ RetrieveMessage() [2/3]

fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::RetrieveMessage ( )

◆ ~RetrieveMessage()

fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::~RetrieveMessage ( )

Destructor.

Definition at line 258 of file PclDatabaseRetrieveInterface.cpp.

References fawkes::Message::data_ptr.

◆ RetrieveMessage() [3/3]

fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::RetrieveMessage ( const RetrieveMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 266 of file PclDatabaseRetrieveInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 466 of file PclDatabaseRetrieveInterface.cpp.

◆ collection()

char * fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 354 of file PclDatabaseRetrieveInterface.cpp.

◆ database()

char * fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 318 of file PclDatabaseRetrieveInterface.cpp.

◆ is_original_timestamp()

bool fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::is_original_timestamp ( ) const

Get original_timestamp value.

Set to true to set the original timestamp on the point cloud, false (default) to publish with current time.

Returns
original_timestamp value

Definition at line 432 of file PclDatabaseRetrieveInterface.cpp.

◆ maxlenof_collection()

size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 364 of file PclDatabaseRetrieveInterface.cpp.

◆ maxlenof_database()

size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 328 of file PclDatabaseRetrieveInterface.cpp.

◆ maxlenof_original_timestamp()

size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_original_timestamp ( ) const

Get maximum length of original_timestamp value.

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

Definition at line 442 of file PclDatabaseRetrieveInterface.cpp.

◆ maxlenof_target_frame()

size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_target_frame ( ) const

Get maximum length of target_frame value.

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

Definition at line 403 of file PclDatabaseRetrieveInterface.cpp.

◆ maxlenof_timestamp()

size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_timestamp ( ) const

Get maximum length of timestamp value.

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

Definition at line 293 of file PclDatabaseRetrieveInterface.cpp.

◆ set_collection()

void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 377 of file PclDatabaseRetrieveInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_database()

void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::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 341 of file PclDatabaseRetrieveInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_original_timestamp()

void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::set_original_timestamp ( const bool  new_original_timestamp)

Set original_timestamp value.

Set to true to set the original timestamp on the point cloud, false (default) to publish with current time.

Parameters
new_original_timestampnew original_timestamp value

Definition at line 455 of file PclDatabaseRetrieveInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_target_frame()

void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::set_target_frame ( const char *  new_target_frame)

Set target_frame value.

Coordinate frame to which to transform the output point cloud. The transformation will be done through a fixed frame specified in the plugin config. If empty, no transformation is performed. If set to "SENSOR" will convert to the sensor frame specified in the plugin config.

Parameters
new_target_framenew target_frame value

Definition at line 419 of file PclDatabaseRetrieveInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ set_timestamp()

void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::set_timestamp ( const int64_t  new_timestamp)

Set timestamp value.

Timestamp for which to retrieve the most recent point clouds.

Parameters
new_timestampnew timestamp value

Definition at line 305 of file PclDatabaseRetrieveInterface.cpp.

Referenced by PointCloudDBROSCommThread::loop().

◆ target_frame()

char * fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::target_frame ( ) const

Get target_frame value.

Coordinate frame to which to transform the output point cloud. The transformation will be done through a fixed frame specified in the plugin config. If empty, no transformation is performed. If set to "SENSOR" will convert to the sensor frame specified in the plugin config.

Returns
target_frame value

Definition at line 393 of file PclDatabaseRetrieveInterface.cpp.

◆ timestamp()

int64_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::timestamp ( ) const

Get timestamp value.

Timestamp for which to retrieve the most recent point clouds.

Returns
timestamp value

Definition at line 283 of file PclDatabaseRetrieveInterface.cpp.


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