fawkes::LocalizerControlInterface::ResetMessage Class Reference

ResetMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/LocalizerControlInterface.h>

Inheritance diagram for fawkes::LocalizerControlInterface::ResetMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  ResetMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 ResetMessage (const float ini_x, const float ini_y, const float ini_ori, const float ini_variance)
 Constructor with initial values.
 ResetMessage ()
 Constructor.
 ~ResetMessage ()
 Destructor.
 ResetMessage (const ResetMessage *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 ori () const
 Get ori value.
void set_ori (const float new_ori)
 Set ori value.
size_t maxlenof_ori () const
 Get maximum length of ori value.
float variance () const
 Get variance value.
void set_variance (const float new_variance)
 Set variance value.
size_t maxlenof_variance () const
 Get maximum length of variance value.
virtual Message * clone () const
 Clone this message.

Detailed Description

ResetMessage Fawkes BlackBoard Interface Message.

Definition at line 52 of file LocalizerControlInterface.h.

Constructor & Destructor Documentation

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage ( const float  ini_x,
const float  ini_y,
const float  ini_ori,
const float  ini_variance 
)

Constructor with initial values.

Parameters:
ini_x initial value for x
ini_y initial value for y
ini_ori initial value for ori
ini_variance initial value for variance

Definition at line 137 of file LocalizerControlInterface.cpp.

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

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage (  ) 

Constructor.

Definition at line 153 of file LocalizerControlInterface.cpp.

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

Referenced by clone().

fawkes::LocalizerControlInterface::ResetMessage::~ResetMessage (  ) 

Destructor.

Definition at line 166 of file LocalizerControlInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage ( const ResetMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 174 of file LocalizerControlInterface.cpp.

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

Member Function Documentation

Message * fawkes::LocalizerControlInterface::ResetMessage::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 309 of file LocalizerControlInterface.cpp.

References ResetMessage().

size_t fawkes::LocalizerControlInterface::ResetMessage::maxlenof_ori (  )  const

Get maximum length of ori value.

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

Definition at line 258 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::maxlenof_variance (  )  const

Get maximum length of variance value.

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

Definition at line 288 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::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 198 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::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 228 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::ori (  )  const

Get ori value.

The new initial orientation.

Returns:
ori value

Definition at line 248 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_ori ( const float  new_ori  ) 

Set ori value.

The new initial orientation.

Parameters:
new_ori new ori value

Definition at line 268 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_variance ( const float  new_variance  ) 

Set variance value.

The variance for the reset position.

Parameters:
new_variance new variance value

Definition at line 298 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_x ( const float  new_x  ) 

Set x value.

The new initial x-coordinate.

Parameters:
new_x new x value

Definition at line 208 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_y ( const float  new_y  ) 

Set y value.

The new initial x-coordinate.

Parameters:
new_y new y value

Definition at line 238 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::variance (  )  const

Get variance value.

The variance for the reset position.

Returns:
variance value

Definition at line 278 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::x (  )  const

Get x value.

The new initial x-coordinate.

Returns:
x value

Definition at line 188 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::y (  )  const

Get y value.

The new initial x-coordinate.

Returns:
y value

Definition at line 218 of file LocalizerControlInterface.cpp.

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