fawkes::HumanoidMotionInterface::YawPitchHeadMessage Class Reference

YawPitchHeadMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/HumanoidMotionInterface.h>

Inheritance diagram for fawkes::HumanoidMotionInterface::YawPitchHeadMessage:

[legend]
List of all members.

Public Member Functions

 YawPitchHeadMessage (const float ini_yaw, const float ini_pitch, const float ini_time_sec)
 Constructor with initial values.
 YawPitchHeadMessage ()
 Constructor.
 ~YawPitchHeadMessage ()
 Destructor.
 YawPitchHeadMessage (const YawPitchHeadMessage *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 time_sec () const
 Get time_sec value.
void set_time_sec (const float new_time_sec)
 Set time_sec value.
size_t maxlenof_time_sec () const
 Get maximum length of time_sec value.
virtual Messageclone () const
 Clone this message.

Classes

struct  YawPitchHeadMessage_data_t
 Internal data storage, do NOT modify!

Detailed Description

YawPitchHeadMessage Fawkes BlackBoard Interface Message.

Definition at line 580 of file HumanoidMotionInterface.h.


Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::YawPitchHeadMessage::YawPitchHeadMessage ( const float  ini_yaw,
const float  ini_pitch,
const float  ini_time_sec 
)

Constructor with initial values.

Parameters:
ini_yaw initial value for yaw
ini_pitch initial value for pitch
ini_time_sec initial value for time_sec

Definition at line 2714 of file HumanoidMotionInterface.cpp.

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

fawkes::HumanoidMotionInterface::YawPitchHeadMessage::YawPitchHeadMessage (  ) 

Constructor.

Definition at line 2729 of file HumanoidMotionInterface.cpp.

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

fawkes::HumanoidMotionInterface::YawPitchHeadMessage::~YawPitchHeadMessage (  ) 

Destructor.

Definition at line 2742 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::YawPitchHeadMessage::YawPitchHeadMessage ( const YawPitchHeadMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 2750 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

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

size_t fawkes::HumanoidMotionInterface::YawPitchHeadMessage::maxlenof_time_sec (  )  const

Get maximum length of time_sec value.

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

Definition at line 2835 of file HumanoidMotionInterface.cpp.

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

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

Get pitch value.

Desired pitch (vertical orientation).

Returns:
pitch value

Definition at line 2795 of file HumanoidMotionInterface.cpp.

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

Set pitch value.

Desired pitch (vertical orientation).

Parameters:
new_pitch new pitch value

Definition at line 2815 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::YawPitchHeadMessage::set_time_sec ( const float  new_time_sec  ) 

Set time_sec value.

Time in seconds when to reach the target.

Parameters:
new_time_sec new time_sec value

Definition at line 2845 of file HumanoidMotionInterface.cpp.

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

Set yaw value.

Desired yaw (horizontal orientation).

Parameters:
new_yaw new yaw value

Definition at line 2785 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::YawPitchHeadMessage::time_sec (  )  const

Get time_sec value.

Time in seconds when to reach the target.

Returns:
time_sec value

Definition at line 2825 of file HumanoidMotionInterface.cpp.

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

Get yaw value.

Desired yaw (horizontal orientation).

Returns:
yaw value

Definition at line 2765 of file HumanoidMotionInterface.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:40 2011 for Fawkes API by  doxygen 1.4.7