Fawkes API Fawkes Development Version
|
StateChangeMessage Fawkes BlackBoard Interface Message. More...
#include <>>
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 Message * | clone () const |
Clone this message. More... | |
![]() | |
Message (const char *type) | |
Constructor. More... | |
Message (const Message *mesg) | |
Copy constructor. More... | |
Message (const Message &mesg) | |
Copy constructor. More... | |
virtual | ~Message () |
Destructor. More... | |
Message & | operator= (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 Time * | time_enqueued () const |
Get time when message was enqueued. More... | |
Uuid | sender_id () const |
Get ID of the immediate sender, not necessarily the creator of the message. More... | |
Uuid | source_id () const |
Get ID of the original source of the message. More... | |
void | set_sender_id (const Uuid &id) |
Set sender ID. More... | |
void | set_source_id (const Uuid &id) |
Set source ID. More... | |
const char * | sender_thread_name () const |
Get sender of message. More... | |
Interface * | interface () 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... | |
virtual Message * | clone () const |
Clone this message. 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... | |
![]() | |
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 | |
![]() | |
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... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, DataT &data) |
Set a field. More... | |
template<class FieldT , class DataT > | |
void | set_field (FieldT &field, unsigned int index, DataT &data) |
Set an array field at a given index. More... | |
![]() | |
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_t * | data_ts |
data timestamp aliasing pointer More... | |
StateChangeMessage Fawkes BlackBoard Interface Message.
Definition at line 54 of file HardwareModelsInterface.h.
fawkes::HardwareModelsInterface::StateChangeMessage::StateChangeMessage | ( | const char * | ini_component, |
const char * | ini_transition | ||
) |
Constructor with initial values.
ini_component | initial value for component |
ini_transition | initial 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.
fawkes::HardwareModelsInterface::StateChangeMessage::StateChangeMessage | ( | ) |
Constructor.
Definition at line 186 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.
fawkes::HardwareModelsInterface::StateChangeMessage::~StateChangeMessage | ( | ) |
Destructor.
Definition at line 198 of file HardwareModelsInterface.cpp.
References fawkes::Interface::data_ptr.
|
explicit |
Copy constructor.
m | message 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.
|
virtual |
Clone this message.
Produces a message of the same type as this message and copies the data to the new message.
Reimplemented from fawkes::Message.
Definition at line 282 of file HardwareModelsInterface.cpp.
char * fawkes::HardwareModelsInterface::StateChangeMessage::component | ( | ) | const |
Get component value.
The component that changed its state
Definition at line 221 of file HardwareModelsInterface.cpp.
Referenced by HardwareModelsThread::loop().
size_t fawkes::HardwareModelsInterface::StateChangeMessage::maxlenof_component | ( | ) | const |
Get maximum length of component value.
Definition at line 231 of file HardwareModelsInterface.cpp.
size_t fawkes::HardwareModelsInterface::StateChangeMessage::maxlenof_transition | ( | ) | const |
Get maximum length of transition value.
Definition at line 261 of file HardwareModelsInterface.cpp.
void fawkes::HardwareModelsInterface::StateChangeMessage::set_component | ( | const char * | new_component | ) |
Set component value.
The component that changed its state
new_component | new component value |
Definition at line 241 of file HardwareModelsInterface.cpp.
References fawkes::Interface::set_field().
void fawkes::HardwareModelsInterface::StateChangeMessage::set_transition | ( | const char * | new_transition | ) |
Set transition value.
The transition executed by the component
new_transition | new transition value |
Definition at line 271 of file HardwareModelsInterface.cpp.
References fawkes::Interface::set_field().
char * fawkes::HardwareModelsInterface::StateChangeMessage::transition | ( | ) | const |
Get transition value.
The transition executed by the component
Definition at line 251 of file HardwareModelsInterface.cpp.
Referenced by HardwareModelsThread::loop().