Classes | Public Member Functions

fawkes::VisualDisplay2DInterface::AddCartCircleMessage Class Reference

AddCartCircleMessage Fawkes BlackBoard Interface Message. More...

#include <>>

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

List of all members.

Classes

struct  AddCartCircleMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 AddCartCircleMessage (const float ini_x, const float ini_y, const float ini_radius, const LineStyle ini_style, const uint8_t *ini_color)
 Constructor with initial values.
 AddCartCircleMessage ()
 Constructor.
 ~AddCartCircleMessage ()
 Destructor.
 AddCartCircleMessage (const AddCartCircleMessage *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 radius () const
 Get radius value.
void set_radius (const float new_radius)
 Set radius value.
size_t maxlenof_radius () const
 Get maximum length of radius 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

AddCartCircleMessage Fawkes BlackBoard Interface Message.

Definition at line 131 of file VisualDisplay2DInterface.h.


Constructor & Destructor Documentation

fawkes::VisualDisplay2DInterface::AddCartCircleMessage::AddCartCircleMessage ( const float  ini_x,
const float  ini_y,
const float  ini_radius,
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_radius initial value for radius
ini_style initial value for style
ini_color initial value for color

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

Destructor.

Definition at line 525 of file VisualDisplay2DInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::VisualDisplay2DInterface::AddCartCircleMessage::AddCartCircleMessage ( const AddCartCircleMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 533 of file VisualDisplay2DInterface.cpp.

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


Member Function Documentation

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

References AddCartCircleMessage().

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

Get color value.

Color in RGBA

Returns:
color value

Definition at line 668 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

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

size_t fawkes::VisualDisplay2DInterface::AddCartCircleMessage::maxlenof_radius (  )  const

Get maximum length of radius value.

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

Definition at line 618 of file VisualDisplay2DInterface.cpp.

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

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

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

float fawkes::VisualDisplay2DInterface::AddCartCircleMessage::radius (  )  const

Get radius value.

Radius of the circle.

Returns:
radius value

Definition at line 608 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Set color value.

Color in RGBA

Parameters:
new_color new color value

Definition at line 703 of file VisualDisplay2DInterface.cpp.

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

void fawkes::VisualDisplay2DInterface::AddCartCircleMessage::set_radius ( const float  new_radius  ) 

Set radius value.

Radius of the circle.

Parameters:
new_radius new radius value

Definition at line 628 of file VisualDisplay2DInterface.cpp.

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

Set style value.

Style of this object.

Parameters:
new_style new style value

Definition at line 658 of file VisualDisplay2DInterface.cpp.

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

Set x value.

X coordinate of center point

Parameters:
new_x new x value

Definition at line 568 of file VisualDisplay2DInterface.cpp.

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

Set y value.

Y coordinate of center point

Parameters:
new_y new y value

Definition at line 598 of file VisualDisplay2DInterface.cpp.

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

Get style value.

Style of this object.

Returns:
style value

Definition at line 638 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get x value.

X coordinate of center point

Returns:
x value

Definition at line 548 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().

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

Get y value.

Y coordinate of center point

Returns:
y value

Definition at line 578 of file VisualDisplay2DInterface.cpp.

Referenced by VisualDisplay2D::process_messages().


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