Fawkes API
Fawkes Development Version
|
AddCartCircleMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Classes | |
struct | AddCartCircleMessage_data_t |
Internal data storage, do NOT modify! |
Public Member Functions | |
AddCartCircleMessage (const float ini_x, const float ini_y, const float ini_radius, const LineStyle ini_style, const uint8_t *ini_color) | |
Constructor with initial values. | |
AddCartCircleMessage () | |
Constructor. | |
~AddCartCircleMessage () | |
Destructor. | |
AddCartCircleMessage (const AddCartCircleMessage *m) | |
Copy constructor. | |
float | x () const |
Get x value. | |
void | set_x (const float new_x) |
Set x value. | |
size_t | maxlenof_x () const |
Get maximum length of x value. | |
float | y () const |
Get y value. | |
void | set_y (const float new_y) |
Set y value. | |
size_t | maxlenof_y () const |
Get maximum length of y value. | |
float | radius () const |
Get radius value. | |
void | set_radius (const float new_radius) |
Set radius value. | |
size_t | maxlenof_radius () const |
Get maximum length of radius value. | |
LineStyle | style () const |
Get style value. | |
void | set_style (const LineStyle new_style) |
Set style value. | |
size_t | maxlenof_style () const |
Get maximum length of style value. | |
uint8_t * | color () const |
Get color value. | |
uint8_t | color (unsigned int index) const |
Get color value at given index. | |
void | set_color (unsigned int index, const uint8_t new_color) |
Set color value at given index. | |
void | set_color (const uint8_t *new_color) |
Set color value. | |
size_t | maxlenof_color () const |
Get maximum length of color value. | |
virtual Message * | clone () const |
Clone this message. | |
![]() | |
Message (const char *type) | |
Constructor. | |
Message (const Message *mesg) | |
Copy constructor. | |
Message (const Message &mesg) | |
Copy constructor. | |
virtual | ~Message () |
Destructor. | |
Message & | operator= (const Message &m) |
Assign this message to given message. | |
unsigned int | id () const |
Get message ID. | |
void | set_id (unsigned int message_id) |
Set message ID. | |
void | mark_enqueued () |
Mark message as being enqueued. | |
bool | enqueued () const |
Check is message has been enqueued. | |
const Time * | time_enqueued () const |
Get time when message was enqueued. | |
unsigned int | sender_id () const |
Get ID of sender. | |
const char * | sender_thread_name () const |
Get sender of message. | |
Interface * | interface () const |
Get transmitting interface. | |
const char * | type () const |
Get message type. | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. | |
unsigned int | num_fields () const |
Get the number of fields in the message. | |
const void * | datachunk () const |
Get pointer to data. | |
unsigned int | datasize () const |
Get size of data. | |
unsigned int | hops () const |
Get number of hops. | |
void | set_hops (unsigned int hops) |
Set number of hops. | |
void | set_from_chunk (const void *chunk) |
Set from raw data chunk. | |
unsigned int | recipient () const |
Get recipient memory serial. | |
template<class MessageType > | |
bool | is_of_type () |
Check if message has desired type. | |
![]() | |
RefCount () | |
Constructor. | |
virtual | ~RefCount () |
Destructor. | |
void | ref () |
Increment reference count. | |
void | unref () |
Decrement reference count and conditionally delete this instance. | |
unsigned int | refcount () |
Get reference count for this instance. |
Additional Inherited Members | |
![]() | |
void | add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0) |
Add an entry to the info list. | |
![]() | |
void * | data_ptr |
Pointer to memory that contains local data. | |
unsigned int | data_size |
Size of memory needed to hold all data. | |
message_data_ts_t * | data_ts |
data timestamp aliasing pointer |
AddCartCircleMessage Fawkes BlackBoard Interface Message.
Definition at line 131 of file VisualDisplay2DInterface.h.
fawkes::VisualDisplay2DInterface::AddCartCircleMessage::AddCartCircleMessage | ( | const float | ini_x, |
const float | ini_y, | ||
const float | ini_radius, | ||
const LineStyle | ini_style, | ||
const uint8_t * | ini_color | ||
) |
Constructor with initial values.
ini_x | initial value for x |
ini_y | initial value for y |
ini_radius | initial value for radius |
ini_style | initial value for style |
ini_color | initial value for color |
Definition at line 491 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BYTE, fawkes::IFT_ENUM, and fawkes::IFT_FLOAT.
fawkes::VisualDisplay2DInterface::AddCartCircleMessage::AddCartCircleMessage | ( | ) |
Constructor.
Definition at line 510 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_BYTE, fawkes::IFT_ENUM, and fawkes::IFT_FLOAT.
fawkes::VisualDisplay2DInterface::AddCartCircleMessage::~AddCartCircleMessage | ( | ) |
Destructor.
Definition at line 525 of file VisualDisplay2DInterface.cpp.
References fawkes::Interface::data_ptr.
fawkes::VisualDisplay2DInterface::AddCartCircleMessage::AddCartCircleMessage | ( | const AddCartCircleMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 533 of file VisualDisplay2DInterface.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 727 of file VisualDisplay2DInterface.cpp.
uint8_t * fawkes::VisualDisplay2DInterface::AddCartCircleMessage::color | ( | ) | const |
Get color value.
Color in RGBA
Definition at line 668 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
uint8_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::color | ( | unsigned int | index | ) | const |
Get color value at given index.
Color in RGBA
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 680 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_color | ( | ) | const |
Get maximum length of color value.
Definition at line 693 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_radius | ( | ) | const |
Get maximum length of radius value.
Definition at line 618 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_style | ( | ) | const |
Get maximum length of style value.
Definition at line 648 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_x | ( | ) | const |
Get maximum length of x value.
Definition at line 558 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_y | ( | ) | const |
Get maximum length of y value.
Definition at line 588 of file VisualDisplay2DInterface.cpp.
float fawkes::VisualDisplay2DInterface::AddCartCircleMessage::radius | ( | ) | const |
Get radius value.
Radius of the circle.
Definition at line 608 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_color | ( | unsigned int | index, |
const uint8_t | new_color | ||
) |
Set color value at given index.
Color in RGBA
new_color | new color value |
index | index for of the value |
Definition at line 714 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_color | ( | const uint8_t * | new_color | ) |
Set color value.
Color in RGBA
new_color | new color value |
Definition at line 703 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_radius | ( | const float | new_radius | ) |
Set radius value.
Radius of the circle.
new_radius | new radius value |
Definition at line 628 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_style | ( | const LineStyle | new_style | ) |
Set style value.
Style of this object.
new_style | new style value |
Definition at line 658 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_x | ( | const float | new_x | ) |
Set x value.
X coordinate of center point
new_x | new x value |
Definition at line 568 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_y | ( | const float | new_y | ) |
Set y value.
Y coordinate of center point
new_y | new y value |
Definition at line 598 of file VisualDisplay2DInterface.cpp.
VisualDisplay2DInterface::LineStyle fawkes::VisualDisplay2DInterface::AddCartCircleMessage::style | ( | ) | const |
Get style value.
Style of this object.
Definition at line 638 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
float fawkes::VisualDisplay2DInterface::AddCartCircleMessage::x | ( | ) | const |
Get x value.
X coordinate of center point
Definition at line 548 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
float fawkes::VisualDisplay2DInterface::AddCartCircleMessage::y | ( | ) | const |
Get y value.
Y coordinate of center point
Definition at line 578 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().