fawkes::VisualDisplay2DInterface::AddCartLineMessage Class Reference

AddCartLineMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/VisualDisplay2DInterface.h>

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

List of all members.

Classes

struct  AddCartLineMessage_data_t
 Internal data storage, do NOT modify!

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.
 AddCartLineMessage ()
 Constructor.
 ~AddCartLineMessage ()
 Destructor.
 AddCartLineMessage (const AddCartLineMessage *m)
 Copy constructor.
float * x () const
 Get x value.
float x (unsigned int index) const
 Get x value at given index.
void set_x (unsigned int index, const float new_x)
 Set x value at given index.
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.
float y (unsigned int index) const
 Get y value at given index.
void set_y (unsigned int index, const float new_y)
 Set y value at given index.
void set_y (const float *new_y)
 Set y value.
size_t maxlenof_y () const
 Get maximum length of y 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

AddCartLineMessage Fawkes BlackBoard Interface Message.

Definition at line 85 of file VisualDisplay2DInterface.h.


Constructor & Destructor Documentation

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.

Parameters:
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 210 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::AddCartLineMessage::AddCartLineMessage (  ) 
fawkes::VisualDisplay2DInterface::AddCartLineMessage::~AddCartLineMessage (  ) 

Destructor.

Definition at line 241 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::VisualDisplay2DInterface::AddCartLineMessage::AddCartLineMessage ( const AddCartLineMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 249 of file VisualDisplay2DInterface.cpp.

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


Member Function Documentation

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

References AddCartLineMessage().

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

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

Get color value.

Color in RGBA

Returns:
color value

Definition at line 414 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

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

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

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

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

Set color value.

Color in RGBA

Parameters:
new_color new color value

Definition at line 449 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

Parameters:
new_color new color value
index index for of the value

Definition at line 460 of file VisualDisplay2DInterface.cpp.

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

Set style value.

Style of this object.

Parameters:
new_style new style value

Definition at line 404 of file VisualDisplay2DInterface.cpp.

void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_x ( const float *  new_x  ) 

Set x value.

X coordinates of two points

Parameters:
new_x new x value

Definition at line 299 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

Parameters:
new_x new x value
index index for of the value

Definition at line 310 of file VisualDisplay2DInterface.cpp.

void fawkes::VisualDisplay2DInterface::AddCartLineMessage::set_y ( const float *  new_y  ) 

Set y value.

Y coordinates of two points

Parameters:
new_y new y value

Definition at line 360 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

Parameters:
new_y new y value
index index for of the value

Definition at line 372 of file VisualDisplay2DInterface.cpp.

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

Get style value.

Style of this object.

Returns:
style value

Definition at line 384 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

Parameters:
index index of value
Returns:
x value
Exceptions:
Exception thrown if index is out of bounds

Definition at line 276 of file VisualDisplay2DInterface.cpp.

float * fawkes::VisualDisplay2DInterface::AddCartLineMessage::x (  )  const

Get x value.

X coordinates of two points

Returns:
x value

Definition at line 264 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

Parameters:
index index of value
Returns:
y value
Exceptions:
Exception thrown if index is out of bounds

Definition at line 336 of file VisualDisplay2DInterface.cpp.

float * fawkes::VisualDisplay2DInterface::AddCartLineMessage::y (  )  const

Get y value.

Y coordinates of two points

Returns:
y value

Definition at line 323 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