AddCartTextMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::VisualDisplay2DInterface::AddCartTextMessage:

Classes
struct	AddCartTextMessage_data_t
	Internal data storage, do NOT modify!

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.
	AddCartTextMessage ()
	Constructor.
	~AddCartTextMessage ()
	Destructor.
	AddCartTextMessage (const AddCartTextMessage *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.
char *	text () const
	Get text value.
void	set_text (const char *new_text)
	Set text value.
size_t	maxlenof_text () const
	Get maximum length of text value.
Anchor	anchor () const
	Get anchor value.
void	set_anchor (const Anchor new_anchor)
	Set anchor value.
size_t	maxlenof_anchor () const
	Get maximum length of anchor value.
float	size () const
	Get size value.
void	set_size (const float new_size)
	Set size value.
size_t	maxlenof_size () const
	Get maximum length of size 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.
Public Member Functions inherited from fawkes::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.
Public Member Functions inherited from fawkes::RefCount
	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
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)
	Add an entry to the info list.
Protected Attributes inherited from fawkes::Message
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

Detailed Description

AddCartTextMessage Fawkes BlackBoard Interface Message.

Definition at line 225 of file VisualDisplay2DInterface.h.

Constructor & Destructor Documentation

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
	)

Constructor with initial values.

Parameters:

ini_x	initial value for x
ini_y	initial value for y
ini_text	initial value for text
ini_anchor	initial value for anchor
ini_size	initial value for size
ini_color	initial value for color

Definition at line 1034 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, fawkes::IFT_FLOAT, and fawkes::IFT_STRING.

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

Constructor.

Definition at line 1055 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, fawkes::IFT_FLOAT, and fawkes::IFT_STRING.

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

Destructor.

Definition at line 1071 of file VisualDisplay2DInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1079 of file VisualDisplay2DInterface.cpp.

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

Member Function Documentation

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 1185 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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 1305 of file VisualDisplay2DInterface.cpp.

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

Get color value.

Color in RGBA

Returns:: color value

Definition at line 1246 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get color value at given index.

Color in RGBA

Parameters:

index index of value

Returns:: color value

Exceptions:

Exception thrown if index is out of bounds

Definition at line 1258 of file VisualDisplay2DInterface.cpp.

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 1195 of file VisualDisplay2DInterface.cpp.

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 1271 of file VisualDisplay2DInterface.cpp.

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 1226 of file VisualDisplay2DInterface.cpp.

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 1164 of file VisualDisplay2DInterface.cpp.

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 1104 of file VisualDisplay2DInterface.cpp.

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 1134 of file VisualDisplay2DInterface.cpp.

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

Set anchor value.

Anchor which marks the alignment to the given point.

Parameters:

new_anchor new anchor value

Definition at line 1206 of file VisualDisplay2DInterface.cpp.

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_color	new color value
index	index for of the value

Definition at line 1292 of file VisualDisplay2DInterface.cpp.

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

Set color value.

Color in RGBA

Parameters:

new_color new color value

Definition at line 1281 of file VisualDisplay2DInterface.cpp.

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

Set size value.

Font size (max height in m).

Parameters:

new_size new size value

Definition at line 1236 of file VisualDisplay2DInterface.cpp.

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

Set text value.

Width of rectangle

Parameters:

new_text new text value

Definition at line 1174 of file VisualDisplay2DInterface.cpp.

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

Set x value.

X coordinate of upper left corner

Parameters:

new_x new x value

Definition at line 1114 of file VisualDisplay2DInterface.cpp.

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

Set y value.

Y coordinate of upper left corner

Parameters:

new_y new y value

Definition at line 1144 of file VisualDisplay2DInterface.cpp.

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

Get size value.

Font size (max height in m).

Returns:: size value

Definition at line 1216 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get text value.

Width of rectangle

Returns:: text value

Definition at line 1154 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get x value.

X coordinate of upper left corner

Returns:: x value

Definition at line 1094 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get y value.

Y coordinate of upper left corner

Returns:: y value

Definition at line 1124 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

src/libs/interfaces/VisualDisplay2DInterface.h
src/libs/interfaces/VisualDisplay2DInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation