Fawkes API
Fawkes Development Version
|
#include <>>
Classes | |
class | CalculateMessage |
class | SetTestIntMessage |
class | SetTestStringMessage |
Public Types | |
enum | TestEnum { TEST_ENUM_1, TEST_ENUM_2 } |
Demonstrating enums. More... | |
Public Member Functions | |
const char * | tostring_TestEnum (TestEnum value) const |
Convert TestEnum constant to string. More... | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. More... | |
bool | is_test_bool () const |
Get test_bool value. More... | |
void | set_test_bool (const bool new_test_bool) |
Set test_bool value. More... | |
size_t | maxlenof_test_bool () const |
Get maximum length of test_bool value. More... | |
int32_t | test_int () const |
Get test_int value. More... | |
void | set_test_int (const int32_t new_test_int) |
Set test_int value. More... | |
size_t | maxlenof_test_int () const |
Get maximum length of test_int value. More... | |
uint8_t | flags () const |
Get flags value. More... | |
void | set_flags (const uint8_t new_flags) |
Set flags value. More... | |
size_t | maxlenof_flags () const |
Get maximum length of flags value. More... | |
char * | test_string () const |
Get test_string value. More... | |
void | set_test_string (const char *new_test_string) |
Set test_string value. More... | |
size_t | maxlenof_test_string () const |
Get maximum length of test_string value. More... | |
int32_t | result () const |
Get result value. More... | |
void | set_result (const int32_t new_result) |
Set result value. More... | |
size_t | maxlenof_result () const |
Get maximum length of result value. More... | |
uint32_t | test_uint () const |
Get test_uint value. More... | |
void | set_test_uint (const uint32_t new_test_uint) |
Set test_uint value. More... | |
size_t | maxlenof_test_uint () const |
Get maximum length of test_uint value. More... | |
virtual Message * | create_message (const char *type) const |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. More... | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
![]() | |
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 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_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... | |
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) 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... | |
Static Public Attributes | |
static const int32_t | TEST_CONSTANT = 5 |
TEST_CONSTANT constant. More... | |
static const float | TEST_FLOAT_CONSTANT = 1.2 |
TEST_FLOAT_CONSTANT constant. 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... | |
![]() | |
void * | data_ptr |
unsigned int | data_size |
bool | data_changed |
interface_data_ts_t * | data_ts |
TestInterface Fawkes BlackBoard Interface. Test interface. Use this to play around. Do NOT remove any fields, as this interface is used by BlackBoard QA.
Definition at line 37 of file TestInterface.h.
Demonstrating enums.
Enumerator | |
---|---|
TEST_ENUM_1 | Item 1. |
TEST_ENUM_2 | Item 2. |
Definition at line 53 of file TestInterface.h.
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 302 of file TestInterface.cpp.
|
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 283 of file TestInterface.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 313 of file TestInterface.cpp.
uint8_t fawkes::TestInterface::flags | ( | ) | const |
Get flags value.
Flags spit down by the writer
Definition at line 161 of file TestInterface.cpp.
bool fawkes::TestInterface::is_test_bool | ( | ) | const |
Get test_bool value.
Test Bool
Definition at line 99 of file TestInterface.cpp.
size_t fawkes::TestInterface::maxlenof_flags | ( | ) | const |
Get maximum length of flags value.
Definition at line 171 of file TestInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::TestInterface::maxlenof_result | ( | ) | const |
Get maximum length of result value.
Definition at line 234 of file TestInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::TestInterface::maxlenof_test_bool | ( | ) | const |
Get maximum length of test_bool value.
Definition at line 109 of file TestInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::TestInterface::maxlenof_test_int | ( | ) | const |
Get maximum length of test_int value.
Definition at line 140 of file TestInterface.cpp.
References fawkes::Interface::data_changed.
size_t fawkes::TestInterface::maxlenof_test_string | ( | ) | const |
Get maximum length of test_string value.
Definition at line 202 of file TestInterface.cpp.
size_t fawkes::TestInterface::maxlenof_test_uint | ( | ) | const |
Get maximum length of test_uint value.
Definition at line 265 of file TestInterface.cpp.
References fawkes::Interface::data_changed.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 645 of file TestInterface.cpp.
int32_t fawkes::TestInterface::result | ( | ) | const |
Get result value.
Result of operation add operation from Calculate message.
Definition at line 224 of file TestInterface.cpp.
void fawkes::TestInterface::set_flags | ( | const uint8_t | new_flags | ) |
Set flags value.
Flags spit down by the writer
new_flags | new flags value |
Definition at line 181 of file TestInterface.cpp.
void fawkes::TestInterface::set_result | ( | const int32_t | new_result | ) |
Set result value.
Result of operation add operation from Calculate message.
new_result | new result value |
Definition at line 244 of file TestInterface.cpp.
Referenced by AgentControlThread::loop().
void fawkes::TestInterface::set_test_bool | ( | const bool | new_test_bool | ) |
Set test_bool value.
Test Bool
new_test_bool | new test_bool value |
Definition at line 119 of file TestInterface.cpp.
void fawkes::TestInterface::set_test_int | ( | const int32_t | new_test_int | ) |
Set test_int value.
Test integer
new_test_int | new test_int value |
Definition at line 150 of file TestInterface.cpp.
void fawkes::TestInterface::set_test_string | ( | const char * | new_test_string | ) |
Set test_string value.
A test sring
new_test_string | new test_string value |
Definition at line 212 of file TestInterface.cpp.
void fawkes::TestInterface::set_test_uint | ( | const uint32_t | new_test_uint | ) |
Set test_uint value.
Test uint32
new_test_uint | new test_uint value |
Definition at line 275 of file TestInterface.cpp.
int32_t fawkes::TestInterface::test_int | ( | ) | const |
Get test_int value.
Test integer
Definition at line 130 of file TestInterface.cpp.
char * fawkes::TestInterface::test_string | ( | ) | const |
Get test_string value.
A test sring
Definition at line 192 of file TestInterface.cpp.
uint32_t fawkes::TestInterface::test_uint | ( | ) | const |
Get test_uint value.
Test uint32
Definition at line 255 of file TestInterface.cpp.
const char * fawkes::TestInterface::tostring_TestEnum | ( | TestEnum | value | ) | const |
Convert TestEnum constant to string.
value | value to convert to string |
Definition at line 85 of file TestInterface.cpp.
|
static |
TEST_CONSTANT constant.
Definition at line 49 of file TestInterface.h.
|
static |
TEST_FLOAT_CONSTANT constant.
Definition at line 50 of file TestInterface.h.