Fawkes API  Fawkes Development Version
fawkes::NavigatorInterface::TurnMessage Class Reference

TurnMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::TurnMessage:

List of all members.

Classes

struct  TurnMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 TurnMessage (const float ini_angle, const float ini_velocity)
 Constructor with initial values.
 TurnMessage ()
 Constructor.
 ~TurnMessage ()
 Destructor.
 TurnMessage (const TurnMessage *m)
 Copy constructor.
float angle () const
 Get angle value.
void set_angle (const float new_angle)
 Set angle value.
size_t maxlenof_angle () const
 Get maximum length of angle value.
float velocity () const
 Get velocity value.
void set_velocity (const float new_velocity)
 Set velocity value.
size_t maxlenof_velocity () const
 Get maximum length of velocity value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::NavigatorInterface::TurnMessage::TurnMessage ( const float  ini_angle,
const float  ini_velocity 
)
fawkes::NavigatorInterface::TurnMessage::~TurnMessage ( )

Destructor.

Definition at line 671 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NavigatorInterface::TurnMessage::TurnMessage ( const TurnMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 679 of file NavigatorInterface.cpp.

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


Member Function Documentation

float fawkes::NavigatorInterface::TurnMessage::angle ( ) const

Get angle value.

Angle of the turn.

Returns:
angle value

Definition at line 694 of file NavigatorInterface.cpp.

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

size_t fawkes::NavigatorInterface::TurnMessage::maxlenof_angle ( ) const

Get maximum length of angle value.

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

Definition at line 704 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::TurnMessage::maxlenof_velocity ( ) const

Get maximum length of velocity value.

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

Definition at line 735 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::TurnMessage::set_angle ( const float  new_angle)

Set angle value.

Angle of the turn.

Parameters:
new_anglenew angle value

Definition at line 714 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::TurnMessage::set_velocity ( const float  new_velocity)

Set velocity value.

The desired turning velocity in rad/s, set to zero to use default value.

Parameters:
new_velocitynew velocity value

Definition at line 746 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::TurnMessage::velocity ( ) const

Get velocity value.

The desired turning velocity in rad/s, set to zero to use default value.

Returns:
velocity value

Definition at line 725 of file NavigatorInterface.cpp.


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