fawkes::HumanoidMotionInterface::TurnMessage Class Reference

TurnMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/HumanoidMotionInterface.h>

Inheritance diagram for fawkes::HumanoidMotionInterface::TurnMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  TurnMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 TurnMessage (const float ini_angle, const unsigned int ini_num_samples)
 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.
unsigned int num_samples () const
 Get num_samples value.
void set_num_samples (const unsigned int new_num_samples)
 Set num_samples value.
size_t maxlenof_num_samples () const
 Get maximum length of num_samples value.
virtual Message * clone () const
 Clone this message.

Detailed Description

TurnMessage Fawkes BlackBoard Interface Message.

Definition at line 358 of file HumanoidMotionInterface.h.

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::TurnMessage::TurnMessage ( const float  ini_angle,
const unsigned int  ini_num_samples 
)

Constructor with initial values.

Parameters:
ini_angle initial value for angle
ini_num_samples initial value for num_samples

Definition at line 1899 of file HumanoidMotionInterface.cpp.

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

fawkes::HumanoidMotionInterface::TurnMessage::TurnMessage (  ) 

Constructor.

Definition at line 1911 of file HumanoidMotionInterface.cpp.

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

Referenced by clone().

fawkes::HumanoidMotionInterface::TurnMessage::~TurnMessage (  ) 

Destructor.

Definition at line 1922 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::TurnMessage::TurnMessage ( const TurnMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1930 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

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

Get angle value.

Angle in radians to turn.

Returns:
angle value

Definition at line 1944 of file HumanoidMotionInterface.cpp.

Message * fawkes::HumanoidMotionInterface::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 2009 of file HumanoidMotionInterface.cpp.

References TurnMessage().

size_t fawkes::HumanoidMotionInterface::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 1954 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::TurnMessage::maxlenof_num_samples (  )  const

Get maximum length of num_samples value.

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

Definition at line 1986 of file HumanoidMotionInterface.cpp.

unsigned int fawkes::HumanoidMotionInterface::TurnMessage::num_samples (  )  const

Get num_samples value.

Number of intermediate samples to use for turning.

Returns:
num_samples value

Definition at line 1976 of file HumanoidMotionInterface.cpp.

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

Set angle value.

Angle in radians to turn.

Parameters:
new_angle new angle value

Definition at line 1964 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::TurnMessage::set_num_samples ( const unsigned int  new_num_samples  ) 

Set num_samples value.

Number of intermediate samples to use for turning.

Parameters:
new_num_samples new num_samples value

Definition at line 1998 of file HumanoidMotionInterface.cpp.

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