Fawkes API
Fawkes Development Version
|
RetrieveMessage Fawkes BlackBoard Interface Message. More...
#include <>>
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 Message * | clone () const |
Clone this message. More... | |
![]() | |
Message (const char *type) | |
Constructor. More... | |
Message (const Message *mesg) | |
Copy constructor. More... | |
Message (const Message &mesg) | |
Copy constructor. More... | |
virtual | ~Message () |
Destructor. More... | |
Message & | operator= (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 Time * | time_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... | |
Interface * | interface () 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... | |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
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_t * | data_ts |
data timestamp aliasing pointer More... | |
RetrieveMessage Fawkes BlackBoard Interface Message.
Definition at line 63 of file PclDatabaseRetrieveInterface.h.
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.
ini_timestamp | initial value for timestamp |
ini_database | initial value for database |
ini_collection | initial value for collection |
ini_target_frame | initial value for target_frame |
ini_original_timestamp | initial 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.
fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::RetrieveMessage | ( | ) |
Constructor.
Definition at line 243 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.
fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::~RetrieveMessage | ( | ) |
Destructor.
Definition at line 258 of file PclDatabaseRetrieveInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::RetrieveMessage | ( | const RetrieveMessage * | m | ) |
Copy constructor.
m | message 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.
|
virtual |
Clone this message.
Produces a message of the same type as this message and copies the data to the new message.
Reimplemented from fawkes::Message.
Definition at line 466 of file PclDatabaseRetrieveInterface.cpp.
char * fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::collection | ( | ) | const |
Get collection value.
Collection name from which to read the point clouds. May NOT include the database name.
Definition at line 354 of file PclDatabaseRetrieveInterface.cpp.
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.
Definition at line 318 of file PclDatabaseRetrieveInterface.cpp.
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.
Definition at line 432 of file PclDatabaseRetrieveInterface.cpp.
size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_collection | ( | ) | const |
Get maximum length of collection value.
Definition at line 364 of file PclDatabaseRetrieveInterface.cpp.
size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_database | ( | ) | const |
Get maximum length of database value.
Definition at line 328 of file PclDatabaseRetrieveInterface.cpp.
size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_original_timestamp | ( | ) | const |
Get maximum length of original_timestamp value.
Definition at line 442 of file PclDatabaseRetrieveInterface.cpp.
size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_target_frame | ( | ) | const |
Get maximum length of target_frame value.
Definition at line 403 of file PclDatabaseRetrieveInterface.cpp.
size_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::maxlenof_timestamp | ( | ) | const |
Get maximum length of timestamp value.
Definition at line 293 of file PclDatabaseRetrieveInterface.cpp.
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.
new_collection | new collection value |
Definition at line 377 of file PclDatabaseRetrieveInterface.cpp.
Referenced by PointCloudDBROSCommThread::loop().
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.
new_database | new database value |
Definition at line 341 of file PclDatabaseRetrieveInterface.cpp.
Referenced by PointCloudDBROSCommThread::loop().
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.
new_original_timestamp | new original_timestamp value |
Definition at line 455 of file PclDatabaseRetrieveInterface.cpp.
Referenced by PointCloudDBROSCommThread::loop().
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.
new_target_frame | new target_frame value |
Definition at line 419 of file PclDatabaseRetrieveInterface.cpp.
Referenced by PointCloudDBROSCommThread::loop().
void fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::set_timestamp | ( | const int64_t | new_timestamp | ) |
Set timestamp value.
Timestamp for which to retrieve the most recent point clouds.
new_timestamp | new timestamp value |
Definition at line 305 of file PclDatabaseRetrieveInterface.cpp.
Referenced by PointCloudDBROSCommThread::loop().
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.
Definition at line 393 of file PclDatabaseRetrieveInterface.cpp.
int64_t fawkes::PclDatabaseRetrieveInterface::RetrieveMessage::timestamp | ( | ) | const |
Get timestamp value.
Timestamp for which to retrieve the most recent point clouds.
Definition at line 283 of file PclDatabaseRetrieveInterface.cpp.