fawkes::VisualDisplay2DInterface::AddCartRectMessage Class Reference

AddCartRectMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/VisualDisplay2DInterface.h>

Inheritance diagram for fawkes::VisualDisplay2DInterface::AddCartRectMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  AddCartRectMessage_data_t
 Internal data storage, do NOT modify!

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.
 AddCartRectMessage ()
 Constructor.
 ~AddCartRectMessage ()
 Destructor.
 AddCartRectMessage (const AddCartRectMessage *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 width () const
 Get width value.
void set_width (const float new_width)
 Set width value.
size_t maxlenof_width () const
 Get maximum length of width value.
float height () const
 Get height value.
void set_height (const float new_height)
 Set height value.
size_t maxlenof_height () const
 Get maximum length of height 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 Messageclone () const
 Clone this message.

Detailed Description

AddCartRectMessage Fawkes BlackBoard Interface Message.

Definition at line 176 of file VisualDisplay2DInterface.h.


Constructor & Destructor Documentation

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 
)

Constructor with initial values.

Parameters:
ini_x initial value for x
ini_y initial value for y
ini_width initial value for width
ini_height initial value for height
ini_style initial value for style
ini_color initial value for color

Definition at line 746 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::AddCartRectMessage::AddCartRectMessage (  ) 
fawkes::VisualDisplay2DInterface::AddCartRectMessage::~AddCartRectMessage (  ) 

Destructor.

Definition at line 783 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 791 of file VisualDisplay2DInterface.cpp.

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


Member Function Documentation

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

References AddCartRectMessage().

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

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

Get color value.

Color in RGBA

Returns:
color value

Definition at line 956 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get height value.

Height of rectangle

Returns:
height value

Definition at line 896 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

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

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

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

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

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

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

Set color value.

Color in RGBA

Parameters:
new_color new color value

Definition at line 991 of file VisualDisplay2DInterface.cpp.

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

Definition at line 1002 of file VisualDisplay2DInterface.cpp.

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

Set height value.

Height of rectangle

Parameters:
new_height new height value

Definition at line 916 of file VisualDisplay2DInterface.cpp.

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

Set style value.

Style of this object.

Parameters:
new_style new style value

Definition at line 946 of file VisualDisplay2DInterface.cpp.

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

Set width value.

Width of rectangle

Parameters:
new_width new width value

Definition at line 886 of file VisualDisplay2DInterface.cpp.

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

Set x value.

X coordinate of lower right corner

Parameters:
new_x new x value

Definition at line 826 of file VisualDisplay2DInterface.cpp.

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

Set y value.

Y coordinate of lower right corner

Parameters:
new_y new y value

Definition at line 856 of file VisualDisplay2DInterface.cpp.

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

Get style value.

Style of this object.

Returns:
style value

Definition at line 926 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get width value.

Width of rectangle

Returns:
width value

Definition at line 866 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get x value.

X coordinate of lower right corner

Returns:
x value

Definition at line 806 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get y value.

Y coordinate of lower right corner

Returns:
y value

Definition at line 836 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1