Fawkes API
Fawkes Development Version
|
DynamicReconfigureInterface Fawkes BlackBoard Interface. More...
#include <>>
Classes | |
class | SetBoolMessage |
SetBoolMessage Fawkes BlackBoard Interface Message. More... | |
class | SetFloatMessage |
SetFloatMessage Fawkes BlackBoard Interface Message. More... | |
class | SetStringMessage |
SetStringMessage Fawkes BlackBoard Interface Message. More... | |
class | SetUint32Message |
SetUint32Message Fawkes BlackBoard Interface Message. More... | |
class | SetUint64Message |
SetUint64Message Fawkes BlackBoard Interface Message. More... | |
Public Types | |
enum | LastMsgStatus { Succeeded , Failed } |
Status of the last send message. More... | |
Public Member Functions | |
const char * | tostring_LastMsgStatus (LastMsgStatus value) const |
Convert LastMsgStatus constant to string. More... | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. More... | |
char * | last_service () const |
Get last_service value. More... | |
void | set_last_service (const char *new_last_service) |
Set last_service value. More... | |
size_t | maxlenof_last_service () const |
Get maximum length of last_service value. More... | |
char * | last_parameter () const |
Get last_parameter value. More... | |
void | set_last_parameter (const char *new_last_parameter) |
Set last_parameter value. More... | |
size_t | maxlenof_last_parameter () const |
Get maximum length of last_parameter value. More... | |
bool | is_last_bool_value () const |
Get last_bool_value value. More... | |
void | set_last_bool_value (const bool new_last_bool_value) |
Set last_bool_value value. More... | |
size_t | maxlenof_last_bool_value () const |
Get maximum length of last_bool_value value. More... | |
char * | last_str_value () const |
Get last_str_value value. More... | |
void | set_last_str_value (const char *new_last_str_value) |
Set last_str_value value. More... | |
size_t | maxlenof_last_str_value () const |
Get maximum length of last_str_value value. More... | |
uint32_t | last_uint32_value () const |
Get last_uint32_value value. More... | |
void | set_last_uint32_value (const uint32_t new_last_uint32_value) |
Set last_uint32_value value. More... | |
size_t | maxlenof_last_uint32_value () const |
Get maximum length of last_uint32_value value. More... | |
uint64_t | last_uint64_value () const |
Get last_uint64_value value. More... | |
void | set_last_uint64_value (const uint64_t new_last_uint64_value) |
Set last_uint64_value value. More... | |
size_t | maxlenof_last_uint64_value () const |
Get maximum length of last_uint64_value value. More... | |
float | last_float_value () const |
Get last_float_value value. More... | |
void | set_last_float_value (const float new_last_float_value) |
Set last_float_value value. More... | |
size_t | maxlenof_last_float_value () const |
Get maximum length of last_float_value value. More... | |
uint64_t | last_msg_id () const |
Get last_msg_id value. More... | |
void | set_last_msg_id (const uint64_t new_last_msg_id) |
Set last_msg_id value. More... | |
size_t | maxlenof_last_msg_id () const |
Get maximum length of last_msg_id value. More... | |
LastMsgStatus | last_msg_status () const |
Get last_msg_status value. More... | |
void | set_last_msg_status (const LastMsgStatus new_last_msg_status) |
Set last_msg_status value. More... | |
size_t | maxlenof_last_msg_status () const |
Get maximum length of last_msg_status value. More... | |
virtual Message * | create_message (const char *type) const |
Create message based on type name. More... | |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. More... | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
Convert arbitrary enum value to string. More... | |
![]() | |
virtual | ~Interface () |
Destructor. More... | |
bool | oftype (const char *interface_type) const |
Check if interface is of given type. More... | |
const void * | datachunk () const |
Get data chunk. More... | |
unsigned int | datasize () const |
Get data size. More... | |
const char * | type () const |
Get type of interface. More... | |
const char * | id () const |
Get identifier of interface. More... | |
const char * | uid () const |
Get unique identifier of interface. More... | |
Uuid | serial () const |
Get instance serial of interface. More... | |
unsigned int | mem_serial () const |
Get memory serial of interface. More... | |
bool | operator== (Interface &comp) const |
Check equality of two interfaces. More... | |
const unsigned char * | hash () const |
Get interface hash. More... | |
size_t | hash_size () const |
Get size of interface hash. More... | |
const char * | hash_printable () const |
Get printable interface hash. More... | |
bool | is_writer () const |
Check if this is a writing instance. More... | |
void | set_validity (bool valid) |
Mark this interface invalid. More... | |
bool | is_valid () const |
Check validity of interface. More... | |
const char * | owner () const |
Get owner of interface. More... | |
void | set_from_chunk (void *chunk) |
Set from a raw data chunk. More... | |
void | resize_buffers (unsigned int num_buffers) |
Resize buffer array. More... | |
unsigned int | num_buffers () const |
Get number of buffers. More... | |
void | copy_shared_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | copy_private_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | read_from_buffer (unsigned int buffer) |
Copy data from buffer to private memory. More... | |
int | compare_buffers (unsigned int buffer) |
Compare buffer to private memory. More... | |
Time | buffer_timestamp (unsigned int buffer) |
Get time of a buffer. More... | |
void | buffer_timestamp (unsigned int buffer, Time *timestamp) |
Get time of a buffer. More... | |
void | read () |
Read from BlackBoard into local copy. More... | |
void | write () |
Write from local copy into BlackBoard memory. More... | |
bool | has_writer () const |
Check if there is a writer for the interface. More... | |
unsigned int | num_readers () const |
Get the number of readers. More... | |
std::string | writer () const |
Get owner name of writing interface instance. More... | |
std::list< std::string > | readers () const |
Get owner names of reading interface instances. More... | |
bool | changed () const |
bool | refreshed () const |
Check if data has been refreshed. More... | |
const Time * | timestamp () const |
Get timestamp of last write. More... | |
void | set_auto_timestamping (bool enabled) |
Enable or disable automated timestamping. More... | |
void | set_timestamp (const Time *t=NULL) |
Set timestamp. More... | |
void | set_clock (Clock *clock) |
Set clock to use for timestamping. More... | |
void | mark_data_refreshed () |
Mark data as refreshed. More... | |
void | mark_data_changed () |
Mark data as changed. More... | |
std::list< const char * > | get_message_types () |
Obtain a list of textual representations of the message types available for this interface. More... | |
unsigned int | msgq_enqueue (Message *message, bool proxy=false) |
Enqueue message at end of queue. More... | |
unsigned int | msgq_enqueue_copy (Message *message) |
Enqueue copy of message at end of queue. More... | |
void | msgq_remove (Message *message) |
Remove message from queue. More... | |
void | msgq_remove (unsigned int message_id) |
Remove message from queue. More... | |
unsigned int | msgq_size () |
Get size of message queue. More... | |
void | msgq_flush () |
Flush all messages. More... | |
void | msgq_lock () |
Lock message queue. More... | |
bool | msgq_try_lock () |
Try to lock message queue. More... | |
void | msgq_unlock () |
Unlock message queue. More... | |
void | msgq_pop () |
Erase first message from queue. More... | |
Message * | msgq_first () |
Get the first message from the message queue. More... | |
bool | msgq_empty () |
Check if queue is empty. More... | |
void | msgq_append (Message *message) |
Enqueue message. More... | |
template<class MessageType > | |
bool | msgq_first_is () |
Check if first message has desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first () |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first (MessageType *&msg) |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first_safe (MessageType *&msg) noexcept |
Get first message casted to the desired type without exceptions. More... | |
MessageQueue::MessageIterator | msgq_begin () |
Get start iterator for message queue. More... | |
MessageQueue::MessageIterator | msgq_end () |
Get end iterator for message queue. More... | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. More... | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. More... | |
unsigned int | num_fields () |
Get the number of fields in the interface. More... | |
Additional Inherited Members | |
![]() | |
static void | parse_uid (const char *uid, std::string &type, std::string &id) |
Parse UID to type and ID strings. More... | |
![]() | |
Interface () | |
Constructor. More... | |
void | set_hash (unsigned char *ihash) |
Set hash. More... | |
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 field info list. More... | |
void | add_messageinfo (const char *name) |
Add an entry to the message info list. More... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, DataT &data) |
Set a field, set data_changed to true and update data_changed accordingly. More... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, unsigned int index, DataT &data) |
Set an array field at a given index, set data_changed to true and update data_changed accordingly. More... | |
![]() | |
void * | data_ptr |
Pointer to local memory storage. More... | |
unsigned int | data_size |
Minimal data size to hold data storage. More... | |
bool | data_refreshed |
Indicator if data can be considered "current", i.e. More... | |
bool | data_changed |
Indicator if the current data is different from the last call to write() This must is automatically updated by set_field. More... | |
interface_data_ts_t * | data_ts |
Pointer to data casted to timestamp struct. More... | |
DynamicReconfigureInterface Fawkes BlackBoard Interface.
Currently only the last set parameter is displayed.
Definition at line 33 of file DynamicReconfigureInterface.h.
Status of the last send message.
Enumerator | |
---|---|
Succeeded | Message was successful send. |
Failed | Message failed. |
Definition at line 42 of file DynamicReconfigureInterface.h.
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 387 of file DynamicReconfigureInterface.cpp.
References fawkes::Interface::type().
|
virtual |
Create message based on type name.
This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 364 of file DynamicReconfigureInterface.cpp.
|
virtual |
Convert arbitrary enum value to string.
Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 398 of file DynamicReconfigureInterface.cpp.
bool fawkes::DynamicReconfigureInterface::is_last_bool_value | ( | ) | const |
Get last_bool_value value.
The last parameter value.
Definition at line 157 of file DynamicReconfigureInterface.cpp.
float fawkes::DynamicReconfigureInterface::last_float_value | ( | ) | const |
Get last_float_value value.
The last parameter value.
Definition at line 277 of file DynamicReconfigureInterface.cpp.
uint64_t fawkes::DynamicReconfigureInterface::last_msg_id | ( | ) | const |
Get last_msg_id value.
The last parameter name.
Definition at line 307 of file DynamicReconfigureInterface.cpp.
DynamicReconfigureInterface::LastMsgStatus fawkes::DynamicReconfigureInterface::last_msg_status | ( | ) | const |
Get last_msg_status value.
The last send message status.
Definition at line 337 of file DynamicReconfigureInterface.cpp.
char * fawkes::DynamicReconfigureInterface::last_parameter | ( | ) | const |
Get last_parameter value.
The last parameter name.
Definition at line 127 of file DynamicReconfigureInterface.cpp.
char * fawkes::DynamicReconfigureInterface::last_service | ( | ) | const |
Get last_service value.
The last service for reconfiguration called.
Definition at line 97 of file DynamicReconfigureInterface.cpp.
char * fawkes::DynamicReconfigureInterface::last_str_value | ( | ) | const |
Get last_str_value value.
The last parameter value.
Definition at line 187 of file DynamicReconfigureInterface.cpp.
uint32_t fawkes::DynamicReconfigureInterface::last_uint32_value | ( | ) | const |
Get last_uint32_value value.
The last parameter value.
Definition at line 217 of file DynamicReconfigureInterface.cpp.
uint64_t fawkes::DynamicReconfigureInterface::last_uint64_value | ( | ) | const |
Get last_uint64_value value.
The last parameter value.
Definition at line 247 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_bool_value | ( | ) | const |
Get maximum length of last_bool_value value.
Definition at line 167 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_float_value | ( | ) | const |
Get maximum length of last_float_value value.
Definition at line 287 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_msg_id | ( | ) | const |
Get maximum length of last_msg_id value.
Definition at line 317 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_msg_status | ( | ) | const |
Get maximum length of last_msg_status value.
Definition at line 347 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_parameter | ( | ) | const |
Get maximum length of last_parameter value.
Definition at line 137 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_service | ( | ) | const |
Get maximum length of last_service value.
Definition at line 107 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_str_value | ( | ) | const |
Get maximum length of last_str_value value.
Definition at line 197 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_uint32_value | ( | ) | const |
Get maximum length of last_uint32_value value.
Definition at line 227 of file DynamicReconfigureInterface.cpp.
size_t fawkes::DynamicReconfigureInterface::maxlenof_last_uint64_value | ( | ) | const |
Get maximum length of last_uint64_value value.
Definition at line 257 of file DynamicReconfigureInterface.cpp.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 1233 of file DynamicReconfigureInterface.cpp.
void fawkes::DynamicReconfigureInterface::set_last_bool_value | ( | const bool | new_last_bool_value | ) |
Set last_bool_value value.
The last parameter value.
new_last_bool_value | new last_bool_value value |
Definition at line 177 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_float_value | ( | const float | new_last_float_value | ) |
Set last_float_value value.
The last parameter value.
new_last_float_value | new last_float_value value |
Definition at line 297 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_msg_id | ( | const uint64_t | new_last_msg_id | ) |
Set last_msg_id value.
The last parameter name.
new_last_msg_id | new last_msg_id value |
Definition at line 327 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_msg_status | ( | const LastMsgStatus | new_last_msg_status | ) |
Set last_msg_status value.
The last send message status.
new_last_msg_status | new last_msg_status value |
Definition at line 357 of file DynamicReconfigureInterface.cpp.
void fawkes::DynamicReconfigureInterface::set_last_parameter | ( | const char * | new_last_parameter | ) |
Set last_parameter value.
The last parameter name.
new_last_parameter | new last_parameter value |
Definition at line 147 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_service | ( | const char * | new_last_service | ) |
Set last_service value.
The last service for reconfiguration called.
new_last_service | new last_service value |
Definition at line 117 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_str_value | ( | const char * | new_last_str_value | ) |
Set last_str_value value.
The last parameter value.
new_last_str_value | new last_str_value value |
Definition at line 207 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_uint32_value | ( | const uint32_t | new_last_uint32_value | ) |
Set last_uint32_value value.
The last parameter value.
new_last_uint32_value | new last_uint32_value value |
Definition at line 237 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
void fawkes::DynamicReconfigureInterface::set_last_uint64_value | ( | const uint64_t | new_last_uint64_value | ) |
Set last_uint64_value value.
The last parameter value.
new_last_uint64_value | new last_uint64_value value |
Definition at line 267 of file DynamicReconfigureInterface.cpp.
Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().
const char * fawkes::DynamicReconfigureInterface::tostring_LastMsgStatus | ( | LastMsgStatus | value | ) | const |
Convert LastMsgStatus constant to string.
value | value to convert to string |
Definition at line 83 of file DynamicReconfigureInterface.cpp.