fawkes::SkillerDebugInterface Class Reference
[Fawkes Interfaces]

SkillerDebugInterface Fawkes BlackBoard Interface. More...

#include <interfaces/SkillerDebugInterface.h>

Inheritance diagram for fawkes::SkillerDebugInterface:

[legend]
List of all members.

Public Types

 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.
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.
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued.
char * graph_fsm () const
 Get graph_fsm value.
void set_graph_fsm (const char *new_graph_fsm)
 Set graph_fsm value.
size_t maxlenof_graph_fsm () const
 Get maximum length of graph_fsm value.
char * graph () const
 Get graph value.
void set_graph (const char *new_graph)
 Set graph value.
size_t maxlenof_graph () const
 Get maximum length of graph value.
GraphDirectionEnum graph_dir () const
 Get graph_dir value.
void set_graph_dir (const GraphDirectionEnum new_graph_dir)
 Set graph_dir value.
size_t maxlenof_graph_dir () const
 Get maximum length of graph_dir value.
bool is_graph_colored () const
 Get graph_colored value.
void set_graph_colored (const bool new_graph_colored)
 Set graph_colored value.
size_t maxlenof_graph_colored () const
 Get maximum length of graph_colored value.
virtual Messagecreate_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string.

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...
struct  SkillerDebugInterface_data_t
 Internal data storage, do NOT modify!

Detailed Description

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.


Member Enumeration Documentation

enum fawkes::SkillerDebugInterface::GraphDirectionEnum

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.


Member Function Documentation

void fawkes::SkillerDebugInterface::copy_values ( const Interface other  )  [virtual]

Copy values from other interface.

Parameters:
other other interface to copy values from

Implements fawkes::Interface.

Definition at line 247 of file SkillerDebugInterface.cpp.

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

Message * fawkes::SkillerDebugInterface::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:
type message type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeException thrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 228 of file SkillerDebugInterface.cpp.

const char * fawkes::SkillerDebugInterface::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:
enumtype enum type as string
val value to convert
Returns:
string representation of value
Exceptions:
UnknownTypeException thrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 258 of file SkillerDebugInterface.cpp.

References tostring_GraphDirectionEnum().

char * fawkes::SkillerDebugInterface::graph (  )  const

Get graph value.

The selected graph in a dot string representation.

Returns:
graph value

Definition at line 128 of file SkillerDebugInterface.cpp.

SkillerDebugInterface::GraphDirectionEnum fawkes::SkillerDebugInterface::graph_dir (  )  const

Get graph_dir value.

Primary direction of current graph.

Returns:
graph_dir value

Definition at line 163 of file SkillerDebugInterface.cpp.

char * fawkes::SkillerDebugInterface::graph_fsm (  )  const

Get graph_fsm value.

The finite state machine (FSM) the current graph has been updated for.

Returns:
graph_fsm value

Definition at line 93 of file SkillerDebugInterface.cpp.

bool fawkes::SkillerDebugInterface::is_graph_colored (  )  const

Get graph_colored value.

True if the graph is colored, false otherwise.

Returns:
graph_colored value

Definition at line 198 of file SkillerDebugInterface.cpp.

size_t fawkes::SkillerDebugInterface::maxlenof_graph (  )  const

Get maximum length of graph value.

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

Definition at line 138 of file SkillerDebugInterface.cpp.

size_t fawkes::SkillerDebugInterface::maxlenof_graph_colored (  )  const

Get maximum length of graph_colored value.

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

Definition at line 208 of file SkillerDebugInterface.cpp.

size_t fawkes::SkillerDebugInterface::maxlenof_graph_dir (  )  const

Get maximum length of graph_dir value.

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

Definition at line 173 of file SkillerDebugInterface.cpp.

size_t fawkes::SkillerDebugInterface::maxlenof_graph_fsm (  )  const

Get maximum length of graph_fsm value.

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

Definition at line 103 of file SkillerDebugInterface.cpp.

bool fawkes::SkillerDebugInterface::message_valid ( const Message message  )  const [virtual]

Check if message is valid and can be enqueued.

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

Implements fawkes::Interface.

Definition at line 554 of file SkillerDebugInterface.cpp.

void fawkes::SkillerDebugInterface::set_graph ( const char *  new_graph  ) 

Set graph value.

The selected graph in a dot string representation.

Parameters:
new_graph new graph value

Definition at line 150 of file SkillerDebugInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by LuaAgentExecutionThread::init().

void fawkes::SkillerDebugInterface::set_graph_colored ( const bool  new_graph_colored  ) 

Set graph_colored value.

True if the graph is colored, false otherwise.

Parameters:
new_graph_colored new graph_colored value

Definition at line 220 of file SkillerDebugInterface.cpp.

References fawkes::Interface::data_changed.

void fawkes::SkillerDebugInterface::set_graph_dir ( const GraphDirectionEnum  new_graph_dir  ) 

Set graph_dir value.

Primary direction of current graph.

Parameters:
new_graph_dir new graph_dir value

Definition at line 185 of file SkillerDebugInterface.cpp.

References fawkes::Interface::data_changed.

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.

Parameters:
new_graph_fsm new graph_fsm value

Definition at line 115 of file SkillerDebugInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by LuaAgentExecutionThread::init().

const char * fawkes::SkillerDebugInterface::tostring_GraphDirectionEnum ( GraphDirectionEnum  value  )  const

Convert GraphDirectionEnum constant to string.

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

Definition at line 75 of file SkillerDebugInterface.cpp.

References GD_BOTTOM_TOP, GD_LEFT_RIGHT, GD_RIGHT_LEFT, and GD_TOP_BOTTOM.

Referenced by enum_tostring().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:36 2011 for Fawkes API by  doxygen 1.4.7