fawkes::NavigatorInterface::ObstacleMessage Class Reference

ObstacleMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/NavigatorInterface.h>

Inheritance diagram for fawkes::NavigatorInterface::ObstacleMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  ObstacleMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 ObstacleMessage (const float ini_x, const float ini_y, const float ini_width)
 Constructor with initial values.
 ObstacleMessage ()
 Constructor.
 ~ObstacleMessage ()
 Destructor.
 ObstacleMessage (const ObstacleMessage *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.
virtual Message * clone () const
 Clone this message.

Detailed Description

ObstacleMessage Fawkes BlackBoard Interface Message.

Definition at line 207 of file NavigatorInterface.h.

Constructor & Destructor Documentation

fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage ( const float  ini_x,
const float  ini_y,
const float  ini_width 
)

Constructor with initial values.

Parameters:
ini_x initial value for x
ini_y initial value for y
ini_width initial value for width

Definition at line 1140 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::IFT_FLOAT.

fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage (  ) 

Constructor.

Definition at line 1154 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::IFT_FLOAT.

Referenced by clone().

fawkes::NavigatorInterface::ObstacleMessage::~ObstacleMessage (  ) 

Destructor.

Definition at line 1166 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage ( const ObstacleMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1174 of file NavigatorInterface.cpp.

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

Member Function Documentation

Message * fawkes::NavigatorInterface::ObstacleMessage::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 1279 of file NavigatorInterface.cpp.

References ObstacleMessage().

size_t fawkes::NavigatorInterface::ObstacleMessage::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 1258 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::ObstacleMessage::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 1198 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::ObstacleMessage::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 1228 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::ObstacleMessage::set_width ( const float  new_width  ) 

Set width value.

Width of the obstacle.

Parameters:
new_width new width value

Definition at line 1268 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::ObstacleMessage::set_x ( const float  new_x  ) 

Set x value.

X-coordinate of the obstacle.

Parameters:
new_x new x value

Definition at line 1208 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::ObstacleMessage::set_y ( const float  new_y  ) 

Set y value.

Y-coordinate of the obstacle.

Parameters:
new_y new y value

Definition at line 1238 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::ObstacleMessage::width (  )  const

Get width value.

Width of the obstacle.

Returns:
width value

Definition at line 1248 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::ObstacleMessage::x (  )  const

Get x value.

X-coordinate of the obstacle.

Returns:
x value

Definition at line 1188 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::ObstacleMessage::y (  )  const

Get y value.

Y-coordinate of the obstacle.

Returns:
y value

Definition at line 1218 of file NavigatorInterface.cpp.

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