Fawkes API
Fawkes Development Version
|
KickMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
KickMessage (const bool ini_left, const bool ini_center, const bool ini_right, const uint32_t ini_intensity) | |
Constructor with initial values. More... | |
KickMessage () | |
Constructor. More... | |
~KickMessage () | |
Destructor. More... | |
KickMessage (const KickMessage *m) | |
Copy constructor. More... | |
bool | is_left () const |
Get left value. More... | |
void | set_left (const bool new_left) |
Set left value. More... | |
size_t | maxlenof_left () const |
Get maximum length of left value. More... | |
bool | is_center () const |
Get center value. More... | |
void | set_center (const bool new_center) |
Set center value. More... | |
size_t | maxlenof_center () const |
Get maximum length of center value. More... | |
bool | is_right () const |
Get right value. More... | |
void | set_right (const bool new_right) |
Set right value. More... | |
size_t | maxlenof_right () const |
Get maximum length of right value. More... | |
uint32_t | intensity () const |
Get intensity value. More... | |
void | set_intensity (const uint32_t new_intensity) |
Set intensity value. More... | |
size_t | maxlenof_intensity () const |
Get maximum length of intensity 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... | |
unsigned int | sender_id () const |
Get ID of sender. 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... | |
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... | |
![]() | |
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... | |
KickMessage Fawkes BlackBoard Interface Message.
Definition at line 83 of file KickerInterface.h.
fawkes::KickerInterface::KickMessage::KickMessage | ( | const bool | ini_left, |
const bool | ini_center, | ||
const bool | ini_right, | ||
const uint32_t | ini_intensity | ||
) |
Constructor with initial values.
ini_left | initial value for left |
ini_center | initial value for center |
ini_right | initial value for right |
ini_intensity | initial value for intensity |
Definition at line 314 of file KickerInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::KickerInterface::GUIDE_BALL_LEFT, fawkes::KickerInterface::GUIDE_BALL_RIGHT, fawkes::IFT_BOOL, and fawkes::IFT_UINT32.
fawkes::KickerInterface::KickMessage::KickMessage | ( | ) |
Constructor.
Definition at line 333 of file KickerInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::KickerInterface::GUIDE_BALL_LEFT, fawkes::KickerInterface::GUIDE_BALL_RIGHT, fawkes::IFT_BOOL, and fawkes::IFT_UINT32.
fawkes::KickerInterface::KickMessage::~KickMessage | ( | ) |
Destructor.
Definition at line 349 of file KickerInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::KickerInterface::KickMessage::KickMessage | ( | const KickMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 357 of file KickerInterface.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 493 of file KickerInterface.cpp.
uint32_t fawkes::KickerInterface::KickMessage::intensity | ( | ) | const |
Get intensity value.
Intensity in the range [0..255].
Definition at line 462 of file KickerInterface.cpp.
bool fawkes::KickerInterface::KickMessage::is_center | ( | ) | const |
Get center value.
True to kick with central kicker.
Definition at line 402 of file KickerInterface.cpp.
bool fawkes::KickerInterface::KickMessage::is_left | ( | ) | const |
Get left value.
True to kick with left kicker.
Definition at line 372 of file KickerInterface.cpp.
bool fawkes::KickerInterface::KickMessage::is_right | ( | ) | const |
Get right value.
True to kick with right kicker.
Definition at line 432 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::KickMessage::maxlenof_center | ( | ) | const |
Get maximum length of center value.
Definition at line 412 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::KickMessage::maxlenof_intensity | ( | ) | const |
Get maximum length of intensity value.
Definition at line 472 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::KickMessage::maxlenof_left | ( | ) | const |
Get maximum length of left value.
Definition at line 382 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::KickMessage::maxlenof_right | ( | ) | const |
Get maximum length of right value.
Definition at line 442 of file KickerInterface.cpp.
void fawkes::KickerInterface::KickMessage::set_center | ( | const bool | new_center | ) |
Set center value.
True to kick with central kicker.
new_center | new center value |
Definition at line 422 of file KickerInterface.cpp.
void fawkes::KickerInterface::KickMessage::set_intensity | ( | const uint32_t | new_intensity | ) |
Set intensity value.
Intensity in the range [0..255].
new_intensity | new intensity value |
Definition at line 482 of file KickerInterface.cpp.
void fawkes::KickerInterface::KickMessage::set_left | ( | const bool | new_left | ) |
Set left value.
True to kick with left kicker.
new_left | new left value |
Definition at line 392 of file KickerInterface.cpp.
void fawkes::KickerInterface::KickMessage::set_right | ( | const bool | new_right | ) |
Set right value.
True to kick with right kicker.
new_right | new right value |
Definition at line 452 of file KickerInterface.cpp.