fawkes::NavigatorInterface::PolarGotoMessage Class Reference

PolarGotoMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/NavigatorInterface.h>

Inheritance diagram for fawkes::NavigatorInterface::PolarGotoMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  PolarGotoMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 PolarGotoMessage (const float ini_phi, const float ini_dist, const float ini_orientation)
 Constructor with initial values.
 PolarGotoMessage ()
 Constructor.
 ~PolarGotoMessage ()
 Destructor.
 PolarGotoMessage (const PolarGotoMessage *m)
 Copy constructor.
float phi () const
 Get phi value.
void set_phi (const float new_phi)
 Set phi value.
size_t maxlenof_phi () const
 Get maximum length of phi value.
float dist () const
 Get dist value.
void set_dist (const float new_dist)
 Set dist value.
size_t maxlenof_dist () const
 Get maximum length of dist value.
float orientation () const
 Get orientation value.
void set_orientation (const float new_orientation)
 Set orientation value.
size_t maxlenof_orientation () const
 Get maximum length of orientation value.
virtual Message * clone () const
 Clone this message.

Detailed Description

PolarGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 153 of file NavigatorInterface.h.

Constructor & Destructor Documentation

fawkes::NavigatorInterface::PolarGotoMessage::PolarGotoMessage ( const float  ini_phi,
const float  ini_dist,
const float  ini_orientation 
)

Constructor with initial values.

Parameters:
ini_phi initial value for phi
ini_dist initial value for dist
ini_orientation initial value for orientation

Definition at line 898 of file NavigatorInterface.cpp.

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

fawkes::NavigatorInterface::PolarGotoMessage::PolarGotoMessage (  ) 

Constructor.

Definition at line 912 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::PolarGotoMessage::~PolarGotoMessage (  ) 

Destructor.

Definition at line 924 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 932 of file NavigatorInterface.cpp.

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

Member Function Documentation

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

References PolarGotoMessage().

float fawkes::NavigatorInterface::PolarGotoMessage::dist (  )  const

Get dist value.

Distance to the target.

Returns:
dist value

Definition at line 976 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::PolarGotoMessage::maxlenof_dist (  )  const

Get maximum length of dist value.

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

Definition at line 986 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::PolarGotoMessage::maxlenof_orientation (  )  const

Get maximum length of orientation value.

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

Definition at line 1016 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::PolarGotoMessage::maxlenof_phi (  )  const

Get maximum length of phi value.

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

Definition at line 956 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::PolarGotoMessage::orientation (  )  const

Get orientation value.

The orientation of the robot at the target.

Returns:
orientation value

Definition at line 1006 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::PolarGotoMessage::phi (  )  const

Get phi value.

Angle between the robot's front and the target.

Returns:
phi value

Definition at line 946 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::PolarGotoMessage::set_dist ( const float  new_dist  ) 

Set dist value.

Distance to the target.

Parameters:
new_dist new dist value

Definition at line 996 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::PolarGotoMessage::set_orientation ( const float  new_orientation  ) 

Set orientation value.

The orientation of the robot at the target.

Parameters:
new_orientation new orientation value

Definition at line 1026 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::PolarGotoMessage::set_phi ( const float  new_phi  ) 

Set phi value.

Angle between the robot's front and the target.

Parameters:
new_phi new phi value

Definition at line 966 of file NavigatorInterface.cpp.

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