Fawkes API  Fawkes Development Version
fawkes::HardwareModelsInterface::StateChangeMessage Class Reference

StateChangeMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HardwareModelsInterface::StateChangeMessage:

Public Member Functions

 StateChangeMessage (const char *ini_component, const char *ini_transition)
 Constructor with initial values. More...
 
 StateChangeMessage ()
 Constructor. More...
 
 ~StateChangeMessage ()
 Destructor. More...
 
 StateChangeMessage (const StateChangeMessage *m)
 Copy constructor. More...
 
char * component () const
 Get component value. More...
 
void set_component (const char *new_component)
 Set component value. More...
 
size_t maxlenof_component () const
 Get maximum length of component value. More...
 
char * transition () const
 Get transition value. More...
 
void set_transition (const char *new_transition)
 Set transition value. More...
 
size_t maxlenof_transition () const
 Get maximum length of transition 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

◆ StateChangeMessage() [1/3]

fawkes::HardwareModelsInterface::StateChangeMessage::StateChangeMessage ( const char *  ini_component,
const char *  ini_transition 
)

Constructor with initial values.

Parameters
ini_componentinitial value for component
ini_transitioninitial value for transition

Definition at line 171 of file HardwareModelsInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_STRING.

◆ StateChangeMessage() [2/3]

fawkes::HardwareModelsInterface::StateChangeMessage::StateChangeMessage ( )

◆ ~StateChangeMessage()

fawkes::HardwareModelsInterface::StateChangeMessage::~StateChangeMessage ( )

Destructor.

Definition at line 198 of file HardwareModelsInterface.cpp.

References fawkes::Interface::data_ptr.

◆ StateChangeMessage() [3/3]

fawkes::HardwareModelsInterface::StateChangeMessage::StateChangeMessage ( const StateChangeMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 206 of file HardwareModelsInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::HardwareModelsInterface::StateChangeMessage::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 282 of file HardwareModelsInterface.cpp.

◆ component()

char * fawkes::HardwareModelsInterface::StateChangeMessage::component ( ) const

Get component value.

The component that changed its state

Returns
component value

Definition at line 221 of file HardwareModelsInterface.cpp.

Referenced by HardwareModelsThread::loop().

◆ maxlenof_component()

size_t fawkes::HardwareModelsInterface::StateChangeMessage::maxlenof_component ( ) const

Get maximum length of component value.

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

Definition at line 231 of file HardwareModelsInterface.cpp.

◆ maxlenof_transition()

size_t fawkes::HardwareModelsInterface::StateChangeMessage::maxlenof_transition ( ) const

Get maximum length of transition value.

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

Definition at line 261 of file HardwareModelsInterface.cpp.

◆ set_component()

void fawkes::HardwareModelsInterface::StateChangeMessage::set_component ( const char *  new_component)

Set component value.

The component that changed its state

Parameters
new_componentnew component value

Definition at line 241 of file HardwareModelsInterface.cpp.

References fawkes::change_field().

◆ set_transition()

void fawkes::HardwareModelsInterface::StateChangeMessage::set_transition ( const char *  new_transition)

Set transition value.

The transition executed by the component

Parameters
new_transitionnew transition value

Definition at line 271 of file HardwareModelsInterface.cpp.

References fawkes::change_field().

◆ transition()

char * fawkes::HardwareModelsInterface::StateChangeMessage::transition ( ) const

Get transition value.

The transition executed by the component

Returns
transition value

Definition at line 251 of file HardwareModelsInterface.cpp.

Referenced by HardwareModelsThread::loop().


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