Fawkes API  Fawkes Development Version
fawkes::VisualDisplay2DInterface::AddCartRectMessage Class Reference

AddCartRectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::VisualDisplay2DInterface::AddCartRectMessage:

Public Member Functions

 AddCartRectMessage (const float ini_x, const float ini_y, const float ini_width, const float ini_height, const LineStyle ini_style, const uint8_t *ini_color)
 Constructor with initial values. More...
 
 AddCartRectMessage ()
 Constructor. More...
 
 ~AddCartRectMessage ()
 Destructor. More...
 
 AddCartRectMessage (const AddCartRectMessage *m)
 Copy constructor. More...
 
float x () const
 Get x value. 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...
 
void set_y (const float new_y)
 Set y value. More...
 
size_t maxlenof_y () const
 Get maximum length of y value. More...
 
float width () const
 Get width value. More...
 
void set_width (const float new_width)
 Set width value. More...
 
size_t maxlenof_width () const
 Get maximum length of width value. More...
 
float height () const
 Get height value. More...
 
void set_height (const float new_height)
 Set height value. More...
 
size_t maxlenof_height () const
 Get maximum length of height 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 Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (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 Timetime_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...
 
Interfaceinterface () 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...
 
- Public Member Functions inherited from fawkes::RefCount
 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

- Protected Member Functions inherited from fawkes::Message
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...
 
- Protected Attributes inherited from fawkes::Message
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_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

◆ AddCartRectMessage() [1/3]

fawkes::VisualDisplay2DInterface::AddCartRectMessage::AddCartRectMessage ( const float  ini_x,
const float  ini_y,
const float  ini_width,
const float  ini_height,
const LineStyle  ini_style,
const uint8_t *  ini_color 
)

◆ AddCartRectMessage() [2/3]

◆ ~AddCartRectMessage()

fawkes::VisualDisplay2DInterface::AddCartRectMessage::~AddCartRectMessage ( )

Destructor.

Definition at line 876 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr.

◆ AddCartRectMessage() [3/3]

fawkes::VisualDisplay2DInterface::AddCartRectMessage::AddCartRectMessage ( const AddCartRectMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 884 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

◆ clone()

Message * fawkes::VisualDisplay2DInterface::AddCartRectMessage::clone ( ) const
virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns
clone of this message

Reimplemented from fawkes::Message.

Definition at line 1108 of file VisualDisplay2DInterface.cpp.

◆ color() [1/2]

uint8_t * fawkes::VisualDisplay2DInterface::AddCartRectMessage::color ( ) const

Get color value.

Color in RGBA

Returns
color value

Definition at line 1049 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ color() [2/2]

uint8_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::color ( unsigned int  index) const

Get color value at given index.

Color in RGBA

Parameters
indexindex of value
Returns
color value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 1061 of file VisualDisplay2DInterface.cpp.

◆ height()

float fawkes::VisualDisplay2DInterface::AddCartRectMessage::height ( ) const

Get height value.

Height of rectangle

Returns
height value

Definition at line 989 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ maxlenof_color()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_color ( ) const

Get maximum length of color value.

Returns
length of color value, can be length of the array or number of maximum number of characters for a string

Definition at line 1074 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_height()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_height ( ) const

Get maximum length of height value.

Returns
length of height value, can be length of the array or number of maximum number of characters for a string

Definition at line 999 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_style()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_style ( ) const

Get maximum length of style value.

Returns
length of style value, can be length of the array or number of maximum number of characters for a string

Definition at line 1029 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_width()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_width ( ) const

Get maximum length of width value.

Returns
length of width value, can be length of the array or number of maximum number of characters for a string

Definition at line 969 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_x()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_x ( ) const

Get maximum length of x value.

Returns
length of x value, can be length of the array or number of maximum number of characters for a string

Definition at line 909 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_y()

size_t fawkes::VisualDisplay2DInterface::AddCartRectMessage::maxlenof_y ( ) const

Get maximum length of y value.

Returns
length of y value, can be length of the array or number of maximum number of characters for a string

Definition at line 939 of file VisualDisplay2DInterface.cpp.

◆ set_color() [1/2]

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_color ( unsigned int  index,
const uint8_t  new_color 
)

Set color value at given index.

Color in RGBA

Parameters
new_colornew color value
indexindex for of the value

Definition at line 1095 of file VisualDisplay2DInterface.cpp.

◆ set_color() [2/2]

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_color ( const uint8_t *  new_color)

Set color value.

Color in RGBA

Parameters
new_colornew color value

Definition at line 1084 of file VisualDisplay2DInterface.cpp.

◆ set_height()

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_height ( const float  new_height)

Set height value.

Height of rectangle

Parameters
new_heightnew height value

Definition at line 1009 of file VisualDisplay2DInterface.cpp.

◆ set_style()

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_style ( const LineStyle  new_style)

Set style value.

Style of this object.

Parameters
new_stylenew style value

Definition at line 1039 of file VisualDisplay2DInterface.cpp.

◆ set_width()

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_width ( const float  new_width)

Set width value.

Width of rectangle

Parameters
new_widthnew width value

Definition at line 979 of file VisualDisplay2DInterface.cpp.

◆ set_x()

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_x ( const float  new_x)

Set x value.

X coordinate of lower right corner

Parameters
new_xnew x value

Definition at line 919 of file VisualDisplay2DInterface.cpp.

◆ set_y()

void fawkes::VisualDisplay2DInterface::AddCartRectMessage::set_y ( const float  new_y)

Set y value.

Y coordinate of lower right corner

Parameters
new_ynew y value

Definition at line 949 of file VisualDisplay2DInterface.cpp.

◆ style()

VisualDisplay2DInterface::LineStyle fawkes::VisualDisplay2DInterface::AddCartRectMessage::style ( ) const

Get style value.

Style of this object.

Returns
style value

Definition at line 1019 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ width()

float fawkes::VisualDisplay2DInterface::AddCartRectMessage::width ( ) const

Get width value.

Width of rectangle

Returns
width value

Definition at line 959 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ x()

float fawkes::VisualDisplay2DInterface::AddCartRectMessage::x ( ) const

Get x value.

X coordinate of lower right corner

Returns
x value

Definition at line 899 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ y()

float fawkes::VisualDisplay2DInterface::AddCartRectMessage::y ( ) const

Get y value.

Y coordinate of lower right corner

Returns
y value

Definition at line 929 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().


The documentation for this class was generated from the following files: