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

AddCartTextMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::VisualDisplay2DInterface::AddCartTextMessage:

Public Member Functions

 AddCartTextMessage (const float ini_x, const float ini_y, const char *ini_text, const Anchor ini_anchor, const float ini_size, const uint8_t *ini_color)
 Constructor with initial values. More...
 
 AddCartTextMessage ()
 Constructor. More...
 
 ~AddCartTextMessage ()
 Destructor. More...
 
 AddCartTextMessage (const AddCartTextMessage *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...
 
char * text () const
 Get text value. More...
 
void set_text (const char *new_text)
 Set text value. More...
 
size_t maxlenof_text () const
 Get maximum length of text value. More...
 
Anchor anchor () const
 Get anchor value. More...
 
void set_anchor (const Anchor new_anchor)
 Set anchor value. More...
 
size_t maxlenof_anchor () const
 Get maximum length of anchor value. More...
 
float size () const
 Get size value. More...
 
void set_size (const float new_size)
 Set size value. More...
 
size_t maxlenof_size () const
 Get maximum length of size 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

◆ AddCartTextMessage() [1/3]

fawkes::VisualDisplay2DInterface::AddCartTextMessage::AddCartTextMessage ( const float  ini_x,
const float  ini_y,
const char *  ini_text,
const Anchor  ini_anchor,
const float  ini_size,
const uint8_t *  ini_color 
)

◆ AddCartTextMessage() [2/3]

◆ ~AddCartTextMessage()

fawkes::VisualDisplay2DInterface::AddCartTextMessage::~AddCartTextMessage ( )

Destructor.

Definition at line 1190 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr.

◆ AddCartTextMessage() [3/3]

fawkes::VisualDisplay2DInterface::AddCartTextMessage::AddCartTextMessage ( const AddCartTextMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1198 of file VisualDisplay2DInterface.cpp.

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

Member Function Documentation

◆ anchor()

VisualDisplay2DInterface::Anchor fawkes::VisualDisplay2DInterface::AddCartTextMessage::anchor ( ) const

Get anchor value.

Anchor which marks the alignment to the given point.

Returns
anchor value

Definition at line 1304 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ clone()

Message * fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1424 of file VisualDisplay2DInterface.cpp.

◆ color() [1/2]

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

Get color value.

Color in RGBA

Returns
color value

Definition at line 1365 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ color() [2/2]

uint8_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1377 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_anchor()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::maxlenof_anchor ( ) const

Get maximum length of anchor value.

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

Definition at line 1314 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_color()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1390 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_size()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::maxlenof_size ( ) const

Get maximum length of size value.

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

Definition at line 1345 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_text()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::maxlenof_text ( ) const

Get maximum length of text value.

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

Definition at line 1283 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_x()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1223 of file VisualDisplay2DInterface.cpp.

◆ maxlenof_y()

size_t fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1253 of file VisualDisplay2DInterface.cpp.

◆ set_anchor()

void fawkes::VisualDisplay2DInterface::AddCartTextMessage::set_anchor ( const Anchor  new_anchor)

Set anchor value.

Anchor which marks the alignment to the given point.

Parameters
new_anchornew anchor value

Definition at line 1325 of file VisualDisplay2DInterface.cpp.

◆ set_color() [1/2]

void fawkes::VisualDisplay2DInterface::AddCartTextMessage::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 1411 of file VisualDisplay2DInterface.cpp.

◆ set_color() [2/2]

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

Set color value.

Color in RGBA

Parameters
new_colornew color value

Definition at line 1400 of file VisualDisplay2DInterface.cpp.

◆ set_size()

void fawkes::VisualDisplay2DInterface::AddCartTextMessage::set_size ( const float  new_size)

Set size value.

Font size (max height in m).

Parameters
new_sizenew size value

Definition at line 1355 of file VisualDisplay2DInterface.cpp.

◆ set_text()

void fawkes::VisualDisplay2DInterface::AddCartTextMessage::set_text ( const char *  new_text)

Set text value.

Width of rectangle

Parameters
new_textnew text value

Definition at line 1293 of file VisualDisplay2DInterface.cpp.

◆ set_x()

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

Set x value.

X coordinate of upper left corner

Parameters
new_xnew x value

Definition at line 1233 of file VisualDisplay2DInterface.cpp.

◆ set_y()

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

Set y value.

Y coordinate of upper left corner

Parameters
new_ynew y value

Definition at line 1263 of file VisualDisplay2DInterface.cpp.

◆ size()

float fawkes::VisualDisplay2DInterface::AddCartTextMessage::size ( ) const

Get size value.

Font size (max height in m).

Returns
size value

Definition at line 1335 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ text()

char * fawkes::VisualDisplay2DInterface::AddCartTextMessage::text ( ) const

Get text value.

Width of rectangle

Returns
text value

Definition at line 1273 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ x()

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

Get x value.

X coordinate of upper left corner

Returns
x value

Definition at line 1213 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

◆ y()

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

Get y value.

Y coordinate of upper left corner

Returns
y value

Definition at line 1243 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().


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