Fawkes API Fawkes Development Version

fawkes::NavigatorInterface::PolarGotoMessage Class Reference

PolarGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::PolarGotoMessage:

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 Messageclone () const
 Clone this message.

Detailed Description


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_phiinitial value for phi
ini_distinitial value for dist
ini_orientationinitial value for orientation

Definition at line 931 of file NavigatorInterface.cpp.

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

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

Destructor.

Definition at line 959 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 967 of file NavigatorInterface.cpp.

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


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 1073 of file NavigatorInterface.cpp.

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

Get dist value.

Distance to the target.

Returns:
dist value

Definition at line 1012 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 1022 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 1052 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 992 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 1042 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 982 of file NavigatorInterface.cpp.

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

Set dist value.

Distance to the target.

Parameters:
new_distnew dist value

Definition at line 1032 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_orientationnew orientation value

Definition at line 1062 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_phinew phi value

Definition at line 1002 of file NavigatorInterface.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends