Fawkes API  Fawkes Development Version
fawkes::KeyValueInterface Class Reference

KeyValueInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::KeyValueInterface:

Public Types

enum  ValueType {
  TypeStr, TypeInt, TypeUint, TypeBool,
  TypeByte, TypeFloat
}
 Indicator of current o. More...
 

Public Member Functions

const char * tostring_ValueType (ValueType value) const
 Convert ValueType constant to string. More...
 
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
char * key () const
 Get key value. More...
 
void set_key (const char *new_key)
 Set key value. More...
 
size_t maxlenof_key () const
 Get maximum length of key value. More...
 
ValueType value_type () const
 Get value_type value. More...
 
void set_value_type (const ValueType new_value_type)
 Set value_type value. More...
 
size_t maxlenof_value_type () const
 Get maximum length of value_type value. More...
 
char * value_string () const
 Get value_string value. More...
 
void set_value_string (const char *new_value_string)
 Set value_string value. More...
 
size_t maxlenof_value_string () const
 Get maximum length of value_string value. More...
 
uint32_t value_uint () const
 Get value_uint value. More...
 
void set_value_uint (const uint32_t new_value_uint)
 Set value_uint value. More...
 
size_t maxlenof_value_uint () const
 Get maximum length of value_uint value. More...
 
int32_t value_int () const
 Get value_int value. More...
 
void set_value_int (const int32_t new_value_int)
 Set value_int value. More...
 
size_t maxlenof_value_int () const
 Get maximum length of value_int value. More...
 
bool is_value_bool () const
 Get value_bool value. More...
 
void set_value_bool (const bool new_value_bool)
 Set value_bool value. More...
 
size_t maxlenof_value_bool () const
 Get maximum length of value_bool value. More...
 
uint8_t value_byte () const
 Get value_byte value. More...
 
void set_value_byte (const uint8_t new_value_byte)
 Set value_byte value. More...
 
size_t maxlenof_value_byte () const
 Get maximum length of value_byte value. More...
 
float value_float () const
 Get value_float value. More...
 
void set_value_float (const float new_value_float)
 Set value_float value. More...
 
size_t maxlenof_value_float () const
 Get maximum length of value_float 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

KeyValueInterface Fawkes BlackBoard Interface.

Key-Value interface. Use this to publish Key-Value based information, if you do not want to create a new interface type for the data. This interface can be used for different kind of data, but should only contain one value at a time. Set the value_type field to represent which kind of value should be transported (e.g. TYPE_INT for integer) and fill the data in the correct value field (e.g. value_int).

Definition at line 33 of file KeyValueInterface.h.

Member Enumeration Documentation

◆ ValueType

Indicator of current o.

Enumerator
TypeStr 

The value to be transported is of type string.

TypeInt 

The value to be transported is of type integer.

TypeUint 

The value to be transported is of type unsigned integer.

TypeBool 

The value to be transported is of type boolean.

TypeByte 

The value to be transported is of type byte.

TypeFloat 

The value to be transported is of type float.

Definition at line 42 of file KeyValueInterface.h.

Member Function Documentation

◆ copy_values()

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

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 353 of file KeyValueInterface.cpp.

References fawkes::Message::type(), and fawkes::Interface::type().

◆ create_message()

Message * fawkes::KeyValueInterface::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 342 of file KeyValueInterface.cpp.

◆ enum_tostring()

const char * fawkes::KeyValueInterface::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 364 of file KeyValueInterface.cpp.

◆ is_value_bool()

bool fawkes::KeyValueInterface::is_value_bool ( ) const

Get value_bool value.

Value with type Bool

Returns
value_bool value

Definition at line 252 of file KeyValueInterface.cpp.

◆ key()

char * fawkes::KeyValueInterface::key ( ) const

Get key value.

The key entry

Returns
key value

Definition at line 97 of file KeyValueInterface.cpp.

◆ maxlenof_key()

size_t fawkes::KeyValueInterface::maxlenof_key ( ) const

Get maximum length of key value.

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

Definition at line 107 of file KeyValueInterface.cpp.

◆ maxlenof_value_bool()

size_t fawkes::KeyValueInterface::maxlenof_value_bool ( ) const

Get maximum length of value_bool value.

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

Definition at line 262 of file KeyValueInterface.cpp.

◆ maxlenof_value_byte()

size_t fawkes::KeyValueInterface::maxlenof_value_byte ( ) const

Get maximum length of value_byte value.

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

Definition at line 293 of file KeyValueInterface.cpp.

◆ maxlenof_value_float()

size_t fawkes::KeyValueInterface::maxlenof_value_float ( ) const

Get maximum length of value_float value.

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

Definition at line 324 of file KeyValueInterface.cpp.

◆ maxlenof_value_int()

size_t fawkes::KeyValueInterface::maxlenof_value_int ( ) const

Get maximum length of value_int value.

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

Definition at line 231 of file KeyValueInterface.cpp.

◆ maxlenof_value_string()

size_t fawkes::KeyValueInterface::maxlenof_value_string ( ) const

Get maximum length of value_string value.

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

Definition at line 169 of file KeyValueInterface.cpp.

◆ maxlenof_value_type()

size_t fawkes::KeyValueInterface::maxlenof_value_type ( ) const

Get maximum length of value_type value.

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

Definition at line 138 of file KeyValueInterface.cpp.

◆ maxlenof_value_uint()

size_t fawkes::KeyValueInterface::maxlenof_value_uint ( ) const

Get maximum length of value_uint value.

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

Definition at line 200 of file KeyValueInterface.cpp.

◆ message_valid()

bool fawkes::KeyValueInterface::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 378 of file KeyValueInterface.cpp.

◆ set_key()

void fawkes::KeyValueInterface::set_key ( const char *  new_key)

Set key value.

The key entry

Parameters
new_keynew key value

Definition at line 117 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_bool()

void fawkes::KeyValueInterface::set_value_bool ( const bool  new_value_bool)

Set value_bool value.

Value with type Bool

Parameters
new_value_boolnew value_bool value

Definition at line 272 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_byte()

void fawkes::KeyValueInterface::set_value_byte ( const uint8_t  new_value_byte)

Set value_byte value.

Value with type byte

Parameters
new_value_bytenew value_byte value

Definition at line 303 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_float()

void fawkes::KeyValueInterface::set_value_float ( const float  new_value_float)

Set value_float value.

Value with type float

Parameters
new_value_floatnew value_float value

Definition at line 334 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_int()

void fawkes::KeyValueInterface::set_value_int ( const int32_t  new_value_int)

Set value_int value.

Value with type integer

Parameters
new_value_intnew value_int value

Definition at line 241 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_string()

void fawkes::KeyValueInterface::set_value_string ( const char *  new_value_string)

Set value_string value.

Value with type string

Parameters
new_value_stringnew value_string value

Definition at line 179 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_type()

void fawkes::KeyValueInterface::set_value_type ( const ValueType  new_value_type)

Set value_type value.

The type of the value entry.

Parameters
new_value_typenew value_type value

Definition at line 148 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_value_uint()

void fawkes::KeyValueInterface::set_value_uint ( const uint32_t  new_value_uint)

Set value_uint value.

Value with type uint32

Parameters
new_value_uintnew value_uint value

Definition at line 210 of file KeyValueInterface.cpp.

References fawkes::Interface::data_changed.

◆ tostring_ValueType()

const char * fawkes::KeyValueInterface::tostring_ValueType ( ValueType  value) const

Convert ValueType constant to string.

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

Definition at line 79 of file KeyValueInterface.cpp.

◆ value_byte()

uint8_t fawkes::KeyValueInterface::value_byte ( ) const

Get value_byte value.

Value with type byte

Returns
value_byte value

Definition at line 283 of file KeyValueInterface.cpp.

◆ value_float()

float fawkes::KeyValueInterface::value_float ( ) const

Get value_float value.

Value with type float

Returns
value_float value

Definition at line 314 of file KeyValueInterface.cpp.

◆ value_int()

int32_t fawkes::KeyValueInterface::value_int ( ) const

Get value_int value.

Value with type integer

Returns
value_int value

Definition at line 221 of file KeyValueInterface.cpp.

◆ value_string()

char * fawkes::KeyValueInterface::value_string ( ) const

Get value_string value.

Value with type string

Returns
value_string value

Definition at line 159 of file KeyValueInterface.cpp.

◆ value_type()

KeyValueInterface::ValueType fawkes::KeyValueInterface::value_type ( ) const

Get value_type value.

The type of the value entry.

Returns
value_type value

Definition at line 128 of file KeyValueInterface.cpp.

◆ value_uint()

uint32_t fawkes::KeyValueInterface::value_uint ( ) const

Get value_uint value.

Value with type uint32

Returns
value_uint value

Definition at line 190 of file KeyValueInterface.cpp.


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