Fawkes API  Fawkes Development Version
fawkes::HumanoidMotionInterface::MoveHeadMessage Class Reference

MoveHeadMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::MoveHeadMessage:

List of all members.

Classes

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

Public Member Functions

 MoveHeadMessage (const float ini_yaw, const float ini_pitch, const float ini_speed)
 Constructor with initial values.
 MoveHeadMessage ()
 Constructor.
 ~MoveHeadMessage ()
 Destructor.
 MoveHeadMessage (const MoveHeadMessage *m)
 Copy constructor.
float yaw () const
 Get yaw value.
void set_yaw (const float new_yaw)
 Set yaw value.
size_t maxlenof_yaw () const
 Get maximum length of yaw value.
float pitch () const
 Get pitch value.
void set_pitch (const float new_pitch)
 Set pitch value.
size_t maxlenof_pitch () const
 Get maximum length of pitch value.
float speed () const
 Get speed value.
void set_speed (const float new_speed)
 Set speed value.
size_t maxlenof_speed () const
 Get maximum length of speed value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::MoveHeadMessage::MoveHeadMessage ( const float  ini_yaw,
const float  ini_pitch,
const float  ini_speed 
)
fawkes::HumanoidMotionInterface::MoveHeadMessage::~MoveHeadMessage ( )

Destructor.

Definition at line 1259 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::HumanoidMotionInterface::MoveHeadMessage::MoveHeadMessage ( const MoveHeadMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1267 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_pitch ( ) const

Get maximum length of pitch value.

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

Definition at line 1322 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_speed ( ) const

Get maximum length of speed value.

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

Definition at line 1352 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_yaw ( ) const

Get maximum length of yaw value.

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

Definition at line 1292 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::MoveHeadMessage::pitch ( ) const

Get pitch value.

Desired pitch (vertical orientation).

Returns:
pitch value

Definition at line 1312 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_pitch ( const float  new_pitch)

Set pitch value.

Desired pitch (vertical orientation).

Parameters:
new_pitchnew pitch value

Definition at line 1332 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_speed ( const float  new_speed)

Set speed value.

Maximum speed in [0.0..1.0].

Parameters:
new_speednew speed value

Definition at line 1362 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_yaw ( const float  new_yaw)

Set yaw value.

Desired yaw (horizontal orientation).

Parameters:
new_yawnew yaw value

Definition at line 1302 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::MoveHeadMessage::speed ( ) const

Get speed value.

Maximum speed in [0.0..1.0].

Returns:
speed value

Definition at line 1342 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::MoveHeadMessage::yaw ( ) const

Get yaw value.

Desired yaw (horizontal orientation).

Returns:
yaw value

Definition at line 1282 of file HumanoidMotionInterface.cpp.


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