Fawkes API Fawkes Development Version
|
AcquireControlMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
AcquireControlMessage (const uint32_t ini_controller, const char *ini_controller_thread_name) | |
Constructor with initial values. More... | |
AcquireControlMessage () | |
Constructor. More... | |
~AcquireControlMessage () | |
Destructor. More... | |
AcquireControlMessage (const AcquireControlMessage *m) | |
Copy constructor. More... | |
uint32_t | controller () const |
Get controller value. More... | |
void | set_controller (const uint32_t new_controller) |
Set controller value. More... | |
size_t | maxlenof_controller () const |
Get maximum length of controller value. More... | |
char * | controller_thread_name () const |
Get controller_thread_name value. More... | |
void | set_controller_thread_name (const char *new_controller_thread_name) |
Set controller_thread_name value. More... | |
size_t | maxlenof_controller_thread_name () const |
Get maximum length of controller_thread_name 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... | |
AcquireControlMessage Fawkes BlackBoard Interface Message.
Definition at line 141 of file MotorInterface.h.
fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage | ( | const uint32_t | ini_controller, |
const char * | ini_controller_thread_name | ||
) |
Constructor with initial values.
ini_controller | initial value for controller |
ini_controller_thread_name | initial value for controller_thread_name |
Definition at line 850 of file MotorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_STRING, and fawkes::IFT_UINT32.
fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage | ( | ) |
Constructor.
Definition at line 864 of file MotorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_STRING, and fawkes::IFT_UINT32.
fawkes::MotorInterface::AcquireControlMessage::~AcquireControlMessage | ( | ) |
Destructor.
Definition at line 876 of file MotorInterface.cpp.
References fawkes::Interface::data_ptr.
|
explicit |
Copy constructor.
m | message to copy from |
Definition at line 884 of file MotorInterface.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 974 of file MotorInterface.cpp.
uint32_t fawkes::MotorInterface::AcquireControlMessage::controller | ( | ) | const |
Get controller value.
The ID of the controller. The controller ID is the instance serial of the sending interface. Only from this interface instance command messages are accepted.
Definition at line 902 of file MotorInterface.cpp.
char * fawkes::MotorInterface::AcquireControlMessage::controller_thread_name | ( | ) | const |
Get controller_thread_name value.
The name of the controlling thread, for easier debugging. This is informative only and actually two threads may share an interface instance (although this should be avoided since the interface locking has to be reproduced for these threads then).
Definition at line 939 of file MotorInterface.cpp.
size_t fawkes::MotorInterface::AcquireControlMessage::maxlenof_controller | ( | ) | const |
Get maximum length of controller value.
Definition at line 912 of file MotorInterface.cpp.
size_t fawkes::MotorInterface::AcquireControlMessage::maxlenof_controller_thread_name | ( | ) | const |
Get maximum length of controller_thread_name value.
Definition at line 949 of file MotorInterface.cpp.
void fawkes::MotorInterface::AcquireControlMessage::set_controller | ( | const uint32_t | new_controller | ) |
Set controller value.
The ID of the controller. The controller ID is the instance serial of the sending interface. Only from this interface instance command messages are accepted.
new_controller | new controller value |
Definition at line 925 of file MotorInterface.cpp.
References fawkes::Interface::set_field().
void fawkes::MotorInterface::AcquireControlMessage::set_controller_thread_name | ( | const char * | new_controller_thread_name | ) |
Set controller_thread_name value.
The name of the controlling thread, for easier debugging. This is informative only and actually two threads may share an interface instance (although this should be avoided since the interface locking has to be reproduced for these threads then).
new_controller_thread_name | new controller_thread_name value |
Definition at line 963 of file MotorInterface.cpp.
References fawkes::Interface::set_field().