Fawkes API
Fawkes Development Version
|
SkillerDebugInterface Fawkes BlackBoard Interface. More...
#include <>>
Classes | |
class | SetGraphColoredMessage |
SetGraphColoredMessage Fawkes BlackBoard Interface Message. More... | |
class | SetGraphDirectionMessage |
SetGraphDirectionMessage Fawkes BlackBoard Interface Message. More... | |
class | SetGraphMessage |
SetGraphMessage Fawkes BlackBoard Interface Message. More... | |
Public Types | |
enum | GraphDirectionEnum { GD_TOP_BOTTOM, GD_BOTTOM_TOP, GD_LEFT_RIGHT, GD_RIGHT_LEFT } |
Primary direction of the graph. More... | |
Public Member Functions | |
const char * | tostring_GraphDirectionEnum (GraphDirectionEnum value) const |
Convert GraphDirectionEnum constant to string. More... | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. More... | |
char * | graph_fsm () const |
Get graph_fsm value. More... | |
void | set_graph_fsm (const char *new_graph_fsm) |
Set graph_fsm value. More... | |
size_t | maxlenof_graph_fsm () const |
Get maximum length of graph_fsm value. More... | |
char * | graph () const |
Get graph value. More... | |
void | set_graph (const char *new_graph) |
Set graph value. More... | |
size_t | maxlenof_graph () const |
Get maximum length of graph value. More... | |
GraphDirectionEnum | graph_dir () const |
Get graph_dir value. More... | |
void | set_graph_dir (const GraphDirectionEnum new_graph_dir) |
Set graph_dir value. More... | |
size_t | maxlenof_graph_dir () const |
Get maximum length of graph_dir value. More... | |
bool | is_graph_colored () const |
Get graph_colored value. More... | |
void | set_graph_colored (const bool new_graph_colored) |
Set graph_colored value. More... | |
size_t | maxlenof_graph_colored () const |
Get maximum length of graph_colored 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... | |
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... | |
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 |
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_t * | data_ts |
Pointer to data casted to timestamp struct. More... | |
SkillerDebugInterface Fawkes BlackBoard Interface.
This interface provides internal skiller data that should allow for easier debugging of skills and the skiller in general. The most notable feature is a graph representation in the dot language of the available skills (and highlighting for the currently active skill).
Definition at line 33 of file SkillerDebugInterface.h.
Primary direction of the graph.
Enumerator | |
---|---|
GD_TOP_BOTTOM | From top to bottom. |
GD_BOTTOM_TOP | From bottom to top. |
GD_LEFT_RIGHT | From left to right. |
GD_RIGHT_LEFT | From left to right. |
Definition at line 42 of file SkillerDebugInterface.h.
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 253 of file SkillerDebugInterface.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 234 of file SkillerDebugInterface.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 264 of file SkillerDebugInterface.cpp.
char * fawkes::SkillerDebugInterface::graph | ( | ) | const |
Get graph value.
The selected graph in a dot string representation.
Definition at line 134 of file SkillerDebugInterface.cpp.
Referenced by SkillGuiGtkWindow::~SkillGuiGtkWindow().
SkillerDebugInterface::GraphDirectionEnum fawkes::SkillerDebugInterface::graph_dir | ( | ) | const |
Get graph_dir value.
Primary direction of current graph.
Definition at line 169 of file SkillerDebugInterface.cpp.
Referenced by SkillGuiGtkWindow::~SkillGuiGtkWindow().
char * fawkes::SkillerDebugInterface::graph_fsm | ( | ) | const |
Get graph_fsm value.
The finite state machine (FSM) the current graph has been updated for.
Definition at line 99 of file SkillerDebugInterface.cpp.
Referenced by SkillGuiGtkWindow::~SkillGuiGtkWindow().
bool fawkes::SkillerDebugInterface::is_graph_colored | ( | ) | const |
Get graph_colored value.
True if the graph is colored, false otherwise.
Definition at line 204 of file SkillerDebugInterface.cpp.
Referenced by SkillGuiGtkWindow::~SkillGuiGtkWindow().
size_t fawkes::SkillerDebugInterface::maxlenof_graph | ( | ) | const |
Get maximum length of graph value.
Definition at line 144 of file SkillerDebugInterface.cpp.
size_t fawkes::SkillerDebugInterface::maxlenof_graph_colored | ( | ) | const |
Get maximum length of graph_colored value.
Definition at line 214 of file SkillerDebugInterface.cpp.
size_t fawkes::SkillerDebugInterface::maxlenof_graph_dir | ( | ) | const |
Get maximum length of graph_dir value.
Definition at line 179 of file SkillerDebugInterface.cpp.
size_t fawkes::SkillerDebugInterface::maxlenof_graph_fsm | ( | ) | const |
Get maximum length of graph_fsm value.
Definition at line 109 of file SkillerDebugInterface.cpp.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 584 of file SkillerDebugInterface.cpp.
void fawkes::SkillerDebugInterface::set_graph | ( | const char * | new_graph | ) |
Set graph value.
The selected graph in a dot string representation.
new_graph | new graph value |
Definition at line 156 of file SkillerDebugInterface.cpp.
Referenced by LuaAgentPeriodicExecutionThread::init().
void fawkes::SkillerDebugInterface::set_graph_colored | ( | const bool | new_graph_colored | ) |
Set graph_colored value.
True if the graph is colored, false otherwise.
new_graph_colored | new graph_colored value |
Definition at line 226 of file SkillerDebugInterface.cpp.
void fawkes::SkillerDebugInterface::set_graph_dir | ( | const GraphDirectionEnum | new_graph_dir | ) |
Set graph_dir value.
Primary direction of current graph.
new_graph_dir | new graph_dir value |
Definition at line 191 of file SkillerDebugInterface.cpp.
void fawkes::SkillerDebugInterface::set_graph_fsm | ( | const char * | new_graph_fsm | ) |
Set graph_fsm value.
The finite state machine (FSM) the current graph has been updated for.
new_graph_fsm | new graph_fsm value |
Definition at line 121 of file SkillerDebugInterface.cpp.
Referenced by LuaAgentPeriodicExecutionThread::init().
const char * fawkes::SkillerDebugInterface::tostring_GraphDirectionEnum | ( | GraphDirectionEnum | value | ) | const |
Convert GraphDirectionEnum constant to string.
value | value to convert to string |
Definition at line 81 of file SkillerDebugInterface.cpp.