Fawkes API  Fawkes Development Version
fawkes::SkillerDebugInterface::SetGraphDirectionMessage Class Reference

SetGraphDirectionMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SkillerDebugInterface::SetGraphDirectionMessage:

Public Member Functions

 SetGraphDirectionMessage (const GraphDirectionEnum ini_graph_dir)
 Constructor with initial values. More...
 
 SetGraphDirectionMessage ()
 Constructor. More...
 
 ~SetGraphDirectionMessage ()
 Destructor. More...
 
 SetGraphDirectionMessage (const SetGraphDirectionMessage *m)
 Copy constructor. 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...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
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 info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

◆ SetGraphDirectionMessage() [1/3]

fawkes::SkillerDebugInterface::SetGraphDirectionMessage::SetGraphDirectionMessage ( const GraphDirectionEnum  ini_graph_dir)

◆ SetGraphDirectionMessage() [2/3]

◆ ~SetGraphDirectionMessage()

fawkes::SkillerDebugInterface::SetGraphDirectionMessage::~SetGraphDirectionMessage ( )

Destructor.

Definition at line 415 of file SkillerDebugInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetGraphDirectionMessage() [3/3]

fawkes::SkillerDebugInterface::SetGraphDirectionMessage::SetGraphDirectionMessage ( const SetGraphDirectionMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 423 of file SkillerDebugInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

◆ clone()

Message * fawkes::SkillerDebugInterface::SetGraphDirectionMessage::clone ( ) const
virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns
clone of this message

Reimplemented from fawkes::Message.

Definition at line 473 of file SkillerDebugInterface.cpp.

◆ graph_dir()

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

Get graph_dir value.

Primary direction of current graph.

Returns
graph_dir value

Definition at line 440 of file SkillerDebugInterface.cpp.

Referenced by LuaAgentPeriodicExecutionThread::finalize().

◆ maxlenof_graph_dir()

size_t fawkes::SkillerDebugInterface::SetGraphDirectionMessage::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 450 of file SkillerDebugInterface.cpp.

◆ set_graph_dir()

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

Set graph_dir value.

Primary direction of current graph.

Parameters
new_graph_dirnew graph_dir value

Definition at line 462 of file SkillerDebugInterface.cpp.


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