Fawkes API Fawkes Development Version

fawkes::HumanoidMotionInterface::TurnMessage Class Reference

TurnMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::TurnMessage:

List of all members.

Classes

struct  TurnMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

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

Detailed Description


Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::TurnMessage::TurnMessage ( const float  ini_angle,
const uint32_t  ini_num_samples 
)

Constructor with initial values.

Parameters:
ini_angleinitial value for angle
ini_num_samplesinitial value for num_samples

Definition at line 2191 of file HumanoidMotionInterface.cpp.

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

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

Destructor.

Definition at line 2216 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2224 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

Get angle value.

Angle in radians to turn.

Returns:
angle value

Definition at line 2239 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 2304 of file HumanoidMotionInterface.cpp.

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 2249 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 2281 of file HumanoidMotionInterface.cpp.

uint32_t 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 2271 of file HumanoidMotionInterface.cpp.

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

Set angle value.

Angle in radians to turn.

Parameters:
new_anglenew angle value

Definition at line 2259 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::TurnMessage::set_num_samples ( const uint32_t  new_num_samples)

Set num_samples value.

Number of intermediate samples to use for turning.

Parameters:
new_num_samplesnew num_samples value

Definition at line 2293 of file HumanoidMotionInterface.cpp.


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