Fawkes API  Fawkes Development Version
fawkes::VisualDisplay2DInterface Class Reference

VisualDisplay2DInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::VisualDisplay2DInterface:

Classes

class  AddCartCircleMessage
 AddCartCircleMessage Fawkes BlackBoard Interface Message. More...
 
class  AddCartLineMessage
 AddCartLineMessage Fawkes BlackBoard Interface Message. More...
 
class  AddCartRectMessage
 AddCartRectMessage Fawkes BlackBoard Interface Message. More...
 
class  AddCartTextMessage
 AddCartTextMessage Fawkes BlackBoard Interface Message. More...
 
class  DeleteAllMessage
 DeleteAllMessage Fawkes BlackBoard Interface Message. More...
 
class  DeleteObjectMessage
 DeleteObjectMessage Fawkes BlackBoard Interface Message. More...
 

Public Types

enum  LineStyle { LS_SOLID, LS_DASHED, LS_DOTTED, LS_DASH_DOTTED }
 Enumeration defining the possible line styles. More...
 
enum  Anchor {
  CENTERED, NORTH, EAST, SOUTH,
  WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST,
  NORTH_WEST
}
 Enumeration defining the possible anchor points. More...
 

Public Member Functions

const char * tostring_LineStyle (LineStyle value) const
 Convert LineStyle constant to string. More...
 
const char * tostring_Anchor (Anchor value) const
 Convert Anchor constant to string. More...
 
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
uint32_t counter () const
 Get counter value. More...
 
void set_counter (const uint32_t new_counter)
 Set counter value. More...
 
size_t maxlenof_counter () const
 Get maximum length of counter 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

VisualDisplay2DInterface Fawkes BlackBoard Interface.

This interface provides can be used by graphing applications to provide a graphing service to other components. This is intended to be used for debugging purposes. Usage of the interface should be optional to turn it off during a competition.

Add* messages will add the given object permanently, so the graphical display can be considered as a scenegraph. The message ID is becomes the ID and can be used to delete the object using the DeleteObjectMessage. With the DeleteAll message all objects can be removed (shall only remove objects added by the same sender, thus data drawn by other senders is not touched).

The units shall be in meters and radians. Color is given as four byte RGBA value, one byte for each R, G, B and Alpha.

Definition at line 33 of file VisualDisplay2DInterface.h.

Member Enumeration Documentation

◆ Anchor

Enumeration defining the possible anchor points.

They are used for determining text alignment towards the reference point. The point is at the appropriate position of the bounding box of the text.

Enumerator
CENTERED 

Vertically and horitontally centered.

NORTH 

Top and horiz.

centered.

EAST 

Right and vert.

centered.

SOUTH 

Bottom and horiz.

centered.

WEST 

Left Right .

NORTH_EAST 

Top right.

SOUTH_EAST 

Bottom right.

SOUTH_WEST 

Bottom left.

NORTH_WEST 

Top left.

Definition at line 58 of file VisualDisplay2DInterface.h.

◆ LineStyle

Enumeration defining the possible line styles.

Enumerator
LS_SOLID 

Solid line.

LS_DASHED 

Dashed line.

LS_DOTTED 

Dotted line.

LS_DASH_DOTTED 

Dashed and dotted line.

Definition at line 44 of file VisualDisplay2DInterface.h.

Member Function Documentation

◆ copy_values()

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

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 189 of file VisualDisplay2DInterface.cpp.

References fawkes::Interface::type().

◆ counter()

uint32_t fawkes::VisualDisplay2DInterface::counter ( ) const

Get counter value.

Field

Returns
counter value

Definition at line 136 of file VisualDisplay2DInterface.cpp.

◆ create_message()

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

◆ enum_tostring()

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

◆ maxlenof_counter()

size_t fawkes::VisualDisplay2DInterface::maxlenof_counter ( ) const

Get maximum length of counter value.

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

Definition at line 146 of file VisualDisplay2DInterface.cpp.

◆ message_valid()

bool fawkes::VisualDisplay2DInterface::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 1610 of file VisualDisplay2DInterface.cpp.

◆ set_counter()

void fawkes::VisualDisplay2DInterface::set_counter ( const uint32_t  new_counter)

Set counter value.

Field

Parameters
new_counternew counter value

Definition at line 156 of file VisualDisplay2DInterface.cpp.

References fawkes::Interface::data_changed.

◆ tostring_Anchor()

const char * fawkes::VisualDisplay2DInterface::tostring_Anchor ( Anchor  value) const

Convert Anchor constant to string.

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

Definition at line 115 of file VisualDisplay2DInterface.cpp.

◆ tostring_LineStyle()

const char * fawkes::VisualDisplay2DInterface::tostring_LineStyle ( LineStyle  value) const

Convert LineStyle constant to string.

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

Definition at line 100 of file VisualDisplay2DInterface.cpp.


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