Fawkes API  Fawkes Development Version
fawkes::DynamicReconfigureInterface Class Reference

DynamicReconfigureInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::DynamicReconfigureInterface:

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 Messagecreate_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...
 
- Public Member Functions inherited from fawkes::Interface
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...
 
unsigned short 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
 Check if data has been changed. More...
 
const Timetimestamp () 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_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)
 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...
 
Messagemsgq_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) throw ()
 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 Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 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...
 
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage. More...
 
unsigned int data_size
 Minimal data size to hold data storage. More...
 
bool data_changed
 Indicator if data has changed. More...
 
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

Detailed Description

DynamicReconfigureInterface Fawkes BlackBoard Interface.

Currently only the last set parameter is displayed.

Definition at line 33 of file DynamicReconfigureInterface.h.

Member Enumeration Documentation

◆ LastMsgStatus

Status of the last send message.

Enumerator
Succeeded 

Message was successful send.

Failed 

Message failed.

Definition at line 42 of file DynamicReconfigureInterface.h.

Member Function Documentation

◆ copy_values()

void fawkes::DynamicReconfigureInterface::copy_values ( const Interface other)
virtual

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 399 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::type().

◆ create_message()

Message * fawkes::DynamicReconfigureInterface::create_message ( const char *  type) const
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.

Parameters
typemessage type
Returns
message of the given type, empty
Exceptions
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 376 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::type().

◆ enum_tostring()

const char * fawkes::DynamicReconfigureInterface::enum_tostring ( const char *  enumtype,
int  val 
) const
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.

Parameters
enumtypeenum type as string
valvalue to convert
Returns
string representation of value
Exceptions
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 410 of file DynamicReconfigureInterface.cpp.

◆ is_last_bool_value()

bool fawkes::DynamicReconfigureInterface::is_last_bool_value ( ) const

Get last_bool_value value.

The last parameter value.

Returns
last_bool_value value

Definition at line 161 of file DynamicReconfigureInterface.cpp.

◆ last_float_value()

float fawkes::DynamicReconfigureInterface::last_float_value ( ) const

Get last_float_value value.

The last parameter value.

Returns
last_float_value value

Definition at line 286 of file DynamicReconfigureInterface.cpp.

◆ last_msg_id()

uint64_t fawkes::DynamicReconfigureInterface::last_msg_id ( ) const

Get last_msg_id value.

The last parameter name.

Returns
last_msg_id value

Definition at line 317 of file DynamicReconfigureInterface.cpp.

◆ last_msg_status()

DynamicReconfigureInterface::LastMsgStatus fawkes::DynamicReconfigureInterface::last_msg_status ( ) const

Get last_msg_status value.

The last send message status.

Returns
last_msg_status value

Definition at line 348 of file DynamicReconfigureInterface.cpp.

◆ last_parameter()

char * fawkes::DynamicReconfigureInterface::last_parameter ( ) const

Get last_parameter value.

The last parameter name.

Returns
last_parameter value

Definition at line 129 of file DynamicReconfigureInterface.cpp.

◆ last_service()

char * fawkes::DynamicReconfigureInterface::last_service ( ) const

Get last_service value.

The last service for reconfiguration called.

Returns
last_service value

Definition at line 97 of file DynamicReconfigureInterface.cpp.

◆ last_str_value()

char * fawkes::DynamicReconfigureInterface::last_str_value ( ) const

Get last_str_value value.

The last parameter value.

Returns
last_str_value value

Definition at line 192 of file DynamicReconfigureInterface.cpp.

◆ last_uint32_value()

uint32_t fawkes::DynamicReconfigureInterface::last_uint32_value ( ) const

Get last_uint32_value value.

The last parameter value.

Returns
last_uint32_value value

Definition at line 224 of file DynamicReconfigureInterface.cpp.

◆ last_uint64_value()

uint64_t fawkes::DynamicReconfigureInterface::last_uint64_value ( ) const

Get last_uint64_value value.

The last parameter value.

Returns
last_uint64_value value

Definition at line 255 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_bool_value()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_bool_value ( ) const

Get maximum length of last_bool_value value.

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

Definition at line 171 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_float_value()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_float_value ( ) const

Get maximum length of last_float_value value.

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

Definition at line 296 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_msg_id()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_msg_id ( ) const

Get maximum length of last_msg_id value.

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

Definition at line 327 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_msg_status()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_msg_status ( ) const

Get maximum length of last_msg_status value.

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

Definition at line 358 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_parameter()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_parameter ( ) const

Get maximum length of last_parameter value.

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

Definition at line 139 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_service()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_service ( ) const

Get maximum length of last_service value.

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

Definition at line 107 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_str_value()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_str_value ( ) const

Get maximum length of last_str_value value.

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

Definition at line 202 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_uint32_value()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_uint32_value ( ) const

Get maximum length of last_uint32_value value.

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

Definition at line 234 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_last_uint64_value()

size_t fawkes::DynamicReconfigureInterface::maxlenof_last_uint64_value ( ) const

Get maximum length of last_uint64_value value.

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

Definition at line 265 of file DynamicReconfigureInterface.cpp.

◆ message_valid()

bool fawkes::DynamicReconfigureInterface::message_valid ( const Message message) const
virtual

Check if message is valid and can be enqueued.

Parameters
messageMessage to check
Returns
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 1256 of file DynamicReconfigureInterface.cpp.

◆ set_last_bool_value()

void fawkes::DynamicReconfigureInterface::set_last_bool_value ( const bool  new_last_bool_value)

Set last_bool_value value.

The last parameter value.

Parameters
new_last_bool_valuenew last_bool_value value

Definition at line 181 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_float_value()

void fawkes::DynamicReconfigureInterface::set_last_float_value ( const float  new_last_float_value)

Set last_float_value value.

The last parameter value.

Parameters
new_last_float_valuenew last_float_value value

Definition at line 306 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_msg_id()

void fawkes::DynamicReconfigureInterface::set_last_msg_id ( const uint64_t  new_last_msg_id)

Set last_msg_id value.

The last parameter name.

Parameters
new_last_msg_idnew last_msg_id value

Definition at line 337 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_msg_status()

void fawkes::DynamicReconfigureInterface::set_last_msg_status ( const LastMsgStatus  new_last_msg_status)

Set last_msg_status value.

The last send message status.

Parameters
new_last_msg_statusnew last_msg_status value

Definition at line 368 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_last_parameter()

void fawkes::DynamicReconfigureInterface::set_last_parameter ( const char *  new_last_parameter)

Set last_parameter value.

The last parameter name.

Parameters
new_last_parameternew last_parameter value

Definition at line 149 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_service()

void fawkes::DynamicReconfigureInterface::set_last_service ( const char *  new_last_service)

Set last_service value.

The last service for reconfiguration called.

Parameters
new_last_servicenew last_service value

Definition at line 117 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_str_value()

void fawkes::DynamicReconfigureInterface::set_last_str_value ( const char *  new_last_str_value)

Set last_str_value value.

The last parameter value.

Parameters
new_last_str_valuenew last_str_value value

Definition at line 212 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_uint32_value()

void fawkes::DynamicReconfigureInterface::set_last_uint32_value ( const uint32_t  new_last_uint32_value)

Set last_uint32_value value.

The last parameter value.

Parameters
new_last_uint32_valuenew last_uint32_value value

Definition at line 244 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ set_last_uint64_value()

void fawkes::DynamicReconfigureInterface::set_last_uint64_value ( const uint64_t  new_last_uint64_value)

Set last_uint64_value value.

The last parameter value.

Parameters
new_last_uint64_valuenew last_uint64_value value

Definition at line 275 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RosDynamicReconfigureThread::init(), and RosDynamicReconfigureThread::loop().

◆ tostring_LastMsgStatus()

const char * fawkes::DynamicReconfigureInterface::tostring_LastMsgStatus ( LastMsgStatus  value) const

Convert LastMsgStatus constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 83 of file DynamicReconfigureInterface.cpp.


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