Fawkes API  Fawkes Development Version
fawkes::TestInterface Class Reference

TestInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::TestInterface:

Classes

class  CalculateMessage
 CalculateMessage Fawkes BlackBoard Interface Message. More...
 
class  SetTestIntMessage
 SetTestIntMessage Fawkes BlackBoard Interface Message. More...
 
class  SetTestStringMessage
 SetTestStringMessage Fawkes BlackBoard Interface Message. More...
 

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 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...
 

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 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

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 33 of file TestInterface.h.

Member Enumeration Documentation

◆ TestEnum

Demonstrating enums.

Enumerator
TEST_ENUM_1 

Item 1.

TEST_ENUM_2 

Item 2.

Definition at line 44 of file TestInterface.h.

Member Function Documentation

◆ copy_values()

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

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 297 of file TestInterface.cpp.

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

◆ create_message()

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

◆ enum_tostring()

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

◆ flags()

uint8_t fawkes::TestInterface::flags ( ) const

Get flags value.

Flags spit down by the writer

Returns
flags value

Definition at line 157 of file TestInterface.cpp.

◆ is_test_bool()

bool fawkes::TestInterface::is_test_bool ( ) const

Get test_bool value.

Test Bool

Returns
test_bool value

Definition at line 95 of file TestInterface.cpp.

◆ maxlenof_flags()

size_t fawkes::TestInterface::maxlenof_flags ( ) const

Get maximum length of flags value.

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

Definition at line 167 of file TestInterface.cpp.

◆ maxlenof_result()

size_t fawkes::TestInterface::maxlenof_result ( ) const

Get maximum length of result value.

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

Definition at line 229 of file TestInterface.cpp.

◆ maxlenof_test_bool()

size_t fawkes::TestInterface::maxlenof_test_bool ( ) const

Get maximum length of test_bool value.

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

Definition at line 105 of file TestInterface.cpp.

◆ maxlenof_test_int()

size_t fawkes::TestInterface::maxlenof_test_int ( ) const

Get maximum length of test_int value.

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

Definition at line 136 of file TestInterface.cpp.

◆ maxlenof_test_string()

size_t fawkes::TestInterface::maxlenof_test_string ( ) const

Get maximum length of test_string value.

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

Definition at line 198 of file TestInterface.cpp.

◆ maxlenof_test_uint()

size_t fawkes::TestInterface::maxlenof_test_uint ( ) const

Get maximum length of test_uint value.

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

Definition at line 260 of file TestInterface.cpp.

◆ message_valid()

bool fawkes::TestInterface::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 638 of file TestInterface.cpp.

◆ result()

int32_t fawkes::TestInterface::result ( ) const

Get result value.

Result of operation add operation from Calculate message.

Returns
result value

Definition at line 219 of file TestInterface.cpp.

◆ set_flags()

void fawkes::TestInterface::set_flags ( const uint8_t  new_flags)

Set flags value.

Flags spit down by the writer

Parameters
new_flagsnew flags value

Definition at line 177 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_result()

void fawkes::TestInterface::set_result ( const int32_t  new_result)

Set result value.

Result of operation add operation from Calculate message.

Parameters
new_resultnew result value

Definition at line 239 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by AgentControlThread::loop().

◆ set_test_bool()

void fawkes::TestInterface::set_test_bool ( const bool  new_test_bool)

Set test_bool value.

Test Bool

Parameters
new_test_boolnew test_bool value

Definition at line 115 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_test_int()

void fawkes::TestInterface::set_test_int ( const int32_t  new_test_int)

Set test_int value.

Test integer

Parameters
new_test_intnew test_int value

Definition at line 146 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_test_string()

void fawkes::TestInterface::set_test_string ( const char *  new_test_string)

Set test_string value.

A test sring

Parameters
new_test_stringnew test_string value

Definition at line 208 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

◆ set_test_uint()

void fawkes::TestInterface::set_test_uint ( const uint32_t  new_test_uint)

Set test_uint value.

Test uint32

Parameters
new_test_uintnew test_uint value

Definition at line 270 of file TestInterface.cpp.

References fawkes::Interface::data_changed.

◆ test_int()

int32_t fawkes::TestInterface::test_int ( ) const

Get test_int value.

Test integer

Returns
test_int value

Definition at line 126 of file TestInterface.cpp.

◆ test_string()

char * fawkes::TestInterface::test_string ( ) const

Get test_string value.

A test sring

Returns
test_string value

Definition at line 188 of file TestInterface.cpp.

◆ test_uint()

uint32_t fawkes::TestInterface::test_uint ( ) const

Get test_uint value.

Test uint32

Returns
test_uint value

Definition at line 250 of file TestInterface.cpp.

◆ tostring_TestEnum()

const char * fawkes::TestInterface::tostring_TestEnum ( TestEnum  value) const

Convert TestEnum constant to string.

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

Definition at line 81 of file TestInterface.cpp.

Member Data Documentation

◆ TEST_CONSTANT

const int32_t fawkes::TestInterface::TEST_CONSTANT = 5
static

TEST_CONSTANT constant.

Definition at line 40 of file TestInterface.h.

◆ TEST_FLOAT_CONSTANT

const float fawkes::TestInterface::TEST_FLOAT_CONSTANT = 1.2
static

TEST_FLOAT_CONSTANT constant.

Definition at line 41 of file TestInterface.h.


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