Fawkes API
Fawkes Development Version
|
AddCartLineMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
AddCartLineMessage (const float *ini_x, const float *ini_y, const LineStyle ini_style, const uint8_t *ini_color) | |
Constructor with initial values. More... | |
AddCartLineMessage () | |
Constructor. More... | |
~AddCartLineMessage () | |
Destructor. More... | |
AddCartLineMessage (const AddCartLineMessage *m) | |
Copy constructor. More... | |
float * | x () const |
Get x value. More... | |
float | x (unsigned int index) const |
Get x value at given index. More... | |
void | set_x (unsigned int index, const float new_x) |
Set x value at given index. More... | |
void | set_x (const float *new_x) |
Set x value. More... | |
size_t | maxlenof_x () const |
Get maximum length of x value. More... | |
float * | y () const |
Get y value. More... | |
float | y (unsigned int index) const |
Get y value at given index. More... | |
void | set_y (unsigned int index, const float new_y) |
Set y value at given index. More... | |
void | set_y (const float *new_y) |
Set y value. More... | |
size_t | maxlenof_y () const |
Get maximum length of y value. More... | |
LineStyle | style () const |
Get style value. More... | |
void | set_style (const LineStyle new_style) |
Set style value. More... | |
size_t | maxlenof_style () const |
Get maximum length of style value. More... | |
uint8_t * | color () const |
Get color value. More... | |
uint8_t | color (unsigned int index) const |
Get color value at given index. More... | |
void | set_color (unsigned int index, const uint8_t new_color) |
Set color value at given index. More... | |
void | set_color (const uint8_t *new_color) |
Set color value. More... | |
size_t | maxlenof_color () const |
Get maximum length of color 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... | |
AddCartLineMessage Fawkes BlackBoard Interface Message.
Definition at line 85 of file VisualDisplay2DInterface.h.
fawkes::VisualDisplay2DInterface::AddCartLineMessage::AddCartLineMessage | ( | const float * | ini_x, |
const float * | ini_y, | ||
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_style | initial value for style |
ini_color | initial value for color |
Definition at line 225 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::VisualDisplay2DInterface::CENTERED, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::VisualDisplay2DInterface::EAST, fawkes::IFT_BYTE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::VisualDisplay2DInterface::LS_DASH_DOTTED, fawkes::VisualDisplay2DInterface::LS_DASHED, fawkes::VisualDisplay2DInterface::LS_DOTTED, fawkes::VisualDisplay2DInterface::LS_SOLID, fawkes::VisualDisplay2DInterface::NORTH, fawkes::VisualDisplay2DInterface::NORTH_EAST, fawkes::VisualDisplay2DInterface::NORTH_WEST, fawkes::VisualDisplay2DInterface::SOUTH, fawkes::VisualDisplay2DInterface::SOUTH_EAST, fawkes::VisualDisplay2DInterface::SOUTH_WEST, and fawkes::VisualDisplay2DInterface::WEST.
fawkes::VisualDisplay2DInterface::AddCartLineMessage::AddCartLineMessage | ( | ) |
Constructor.
Definition at line 255 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::VisualDisplay2DInterface::CENTERED, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::VisualDisplay2DInterface::EAST, fawkes::IFT_BYTE, fawkes::IFT_ENUM, fawkes::IFT_FLOAT, fawkes::VisualDisplay2DInterface::LS_DASH_DOTTED, fawkes::VisualDisplay2DInterface::LS_DASHED, fawkes::VisualDisplay2DInterface::LS_DOTTED, fawkes::VisualDisplay2DInterface::LS_SOLID, fawkes::VisualDisplay2DInterface::NORTH, fawkes::VisualDisplay2DInterface::NORTH_EAST, fawkes::VisualDisplay2DInterface::NORTH_WEST, fawkes::VisualDisplay2DInterface::SOUTH, fawkes::VisualDisplay2DInterface::SOUTH_EAST, fawkes::VisualDisplay2DInterface::SOUTH_WEST, and fawkes::VisualDisplay2DInterface::WEST.
fawkes::VisualDisplay2DInterface::AddCartLineMessage::~AddCartLineMessage | ( | ) |
Destructor.
Definition at line 282 of file VisualDisplay2DInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::VisualDisplay2DInterface::AddCartLineMessage::AddCartLineMessage | ( | const AddCartLineMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 290 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 514 of file VisualDisplay2DInterface.cpp.
uint8_t * fawkes::VisualDisplay2DInterface::AddCartLineMessage::color | ( | ) | const |
Get color value.
Color in RGBA
Definition at line 455 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
uint8_t fawkes::VisualDisplay2DInterface::AddCartLineMessage::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 467 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartLineMessage::maxlenof_color | ( | ) | const |
Get maximum length of color value.
Definition at line 480 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartLineMessage::maxlenof_style | ( | ) | const |
Get maximum length of style value.
Definition at line 435 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartLineMessage::maxlenof_x | ( | ) | const |
Get maximum length of x value.
Definition at line 330 of file VisualDisplay2DInterface.cpp.
size_t fawkes::VisualDisplay2DInterface::AddCartLineMessage::maxlenof_y | ( | ) | const |
Get maximum length of y value.
Definition at line 390 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::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 501 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_color | ( | const uint8_t * | new_color | ) |
Set color value.
Color in RGBA
new_color | new color value |
Definition at line 490 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_style | ( | const LineStyle | new_style | ) |
Set style value.
Style of this object.
new_style | new style value |
Definition at line 445 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_x | ( | unsigned int | index, |
const float | new_x | ||
) |
Set x value at given index.
X coordinates of two points
new_x | new x value |
index | index for of the value |
Definition at line 351 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_x | ( | const float * | new_x | ) |
Set x value.
X coordinates of two points
new_x | new x value |
Definition at line 340 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_y | ( | unsigned int | index, |
const float | new_y | ||
) |
Set y value at given index.
Y coordinates of two points
new_y | new y value |
index | index for of the value |
Definition at line 413 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_y | ( | const float * | new_y | ) |
Set y value.
Y coordinates of two points
new_y | new y value |
Definition at line 401 of file VisualDisplay2DInterface.cpp.
VisualDisplay2DInterface::LineStyle fawkes::VisualDisplay2DInterface::AddCartLineMessage::style | ( | ) | const |
Get style value.
Style of this object.
Definition at line 425 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
float * fawkes::VisualDisplay2DInterface::AddCartLineMessage::x | ( | ) | const |
Get x value.
X coordinates of two points
Definition at line 305 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
float fawkes::VisualDisplay2DInterface::AddCartLineMessage::x | ( | unsigned int | index | ) | const |
Get x value at given index.
X coordinates of two points
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 317 of file VisualDisplay2DInterface.cpp.
float * fawkes::VisualDisplay2DInterface::AddCartLineMessage::y | ( | ) | const |
Get y value.
Y coordinates of two points
Definition at line 364 of file VisualDisplay2DInterface.cpp.
Referenced by VisualDisplay2D::process_messages().
float fawkes::VisualDisplay2DInterface::AddCartLineMessage::y | ( | unsigned int | index | ) | const |
Get y value at given index.
Y coordinates of two points
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 377 of file VisualDisplay2DInterface.cpp.