fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage Class Reference

SetWalkArmsParamsMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/HumanoidMotionInterface.h>

Inheritance diagram for fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  SetWalkArmsParamsMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetWalkArmsParamsMessage (const bool ini_arms_enabled, const float ini_shoulder_pitch_median, const float ini_shoulder_pitch_amplitude, const float ini_elbow_roll_median, const float ini_elbow_roll_amplitude)
 Constructor with initial values.
 SetWalkArmsParamsMessage ()
 Constructor.
 ~SetWalkArmsParamsMessage ()
 Destructor.
 SetWalkArmsParamsMessage (const SetWalkArmsParamsMessage *m)
 Copy constructor.
bool is_arms_enabled () const
 Get arms_enabled value.
void set_arms_enabled (const bool new_arms_enabled)
 Set arms_enabled value.
size_t maxlenof_arms_enabled () const
 Get maximum length of arms_enabled value.
float shoulder_pitch_median () const
 Get shoulder_pitch_median value.
void set_shoulder_pitch_median (const float new_shoulder_pitch_median)
 Set shoulder_pitch_median value.
size_t maxlenof_shoulder_pitch_median () const
 Get maximum length of shoulder_pitch_median value.
float shoulder_pitch_amplitude () const
 Get shoulder_pitch_amplitude value.
void set_shoulder_pitch_amplitude (const float new_shoulder_pitch_amplitude)
 Set shoulder_pitch_amplitude value.
size_t maxlenof_shoulder_pitch_amplitude () const
 Get maximum length of shoulder_pitch_amplitude value.
float elbow_roll_median () const
 Get elbow_roll_median value.
void set_elbow_roll_median (const float new_elbow_roll_median)
 Set elbow_roll_median value.
size_t maxlenof_elbow_roll_median () const
 Get maximum length of elbow_roll_median value.
float elbow_roll_amplitude () const
 Get elbow_roll_amplitude value.
void set_elbow_roll_amplitude (const float new_elbow_roll_amplitude)
 Set elbow_roll_amplitude value.
size_t maxlenof_elbow_roll_amplitude () const
 Get maximum length of elbow_roll_amplitude value.
virtual Messageclone () const
 Clone this message.

Detailed Description

SetWalkArmsParamsMessage Fawkes BlackBoard Interface Message.

Definition at line 218 of file HumanoidMotionInterface.h.


Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::SetWalkArmsParamsMessage ( const bool  ini_arms_enabled,
const float  ini_shoulder_pitch_median,
const float  ini_shoulder_pitch_amplitude,
const float  ini_elbow_roll_median,
const float  ini_elbow_roll_amplitude 
)

Constructor with initial values.

Parameters:
ini_arms_enabled initial value for arms_enabled
ini_shoulder_pitch_median initial value for shoulder_pitch_median
ini_shoulder_pitch_amplitude initial value for shoulder_pitch_amplitude
ini_elbow_roll_median initial value for elbow_roll_median
ini_elbow_roll_amplitude initial value for elbow_roll_amplitude

Definition at line 1292 of file HumanoidMotionInterface.cpp.

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

fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::SetWalkArmsParamsMessage (  ) 
fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::~SetWalkArmsParamsMessage (  ) 

Destructor.

Definition at line 1326 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::SetWalkArmsParamsMessage ( const SetWalkArmsParamsMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 1334 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

References SetWalkArmsParamsMessage().

float fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::elbow_roll_amplitude (  )  const

Get elbow_roll_amplitude value.

Amplitude of the elbow roll movement during walking.

Returns:
elbow_roll_amplitude value

Definition at line 1487 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::elbow_roll_median (  )  const

Get elbow_roll_median value.

Median in radians of the elbow roll during walking.

Returns:
elbow_roll_median value

Definition at line 1453 of file HumanoidMotionInterface.cpp.

bool fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::is_arms_enabled (  )  const

Get arms_enabled value.

If true the arms are controlled during walking for balancing.

Returns:
arms_enabled value

Definition at line 1351 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::maxlenof_arms_enabled (  )  const

Get maximum length of arms_enabled value.

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

Definition at line 1361 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::maxlenof_elbow_roll_amplitude (  )  const

Get maximum length of elbow_roll_amplitude value.

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

Definition at line 1497 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::maxlenof_elbow_roll_median (  )  const

Get maximum length of elbow_roll_median value.

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

Definition at line 1463 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::maxlenof_shoulder_pitch_amplitude (  )  const

Get maximum length of shoulder_pitch_amplitude value.

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

Definition at line 1429 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::maxlenof_shoulder_pitch_median (  )  const

Get maximum length of shoulder_pitch_median value.

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

Definition at line 1395 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::set_arms_enabled ( const bool  new_arms_enabled  ) 

Set arms_enabled value.

If true the arms are controlled during walking for balancing.

Parameters:
new_arms_enabled new arms_enabled value

Definition at line 1373 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::set_elbow_roll_amplitude ( const float  new_elbow_roll_amplitude  ) 

Set elbow_roll_amplitude value.

Amplitude of the elbow roll movement during walking.

Parameters:
new_elbow_roll_amplitude new elbow_roll_amplitude value

Definition at line 1509 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::set_elbow_roll_median ( const float  new_elbow_roll_median  ) 

Set elbow_roll_median value.

Median in radians of the elbow roll during walking.

Parameters:
new_elbow_roll_median new elbow_roll_median value

Definition at line 1475 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::set_shoulder_pitch_amplitude ( const float  new_shoulder_pitch_amplitude  ) 

Set shoulder_pitch_amplitude value.

Amplitude of the shoulder pitch movement during walking.

Parameters:
new_shoulder_pitch_amplitude new shoulder_pitch_amplitude value

Definition at line 1441 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::set_shoulder_pitch_median ( const float  new_shoulder_pitch_median  ) 

Set shoulder_pitch_median value.

Median in radians of the shoulder pitch during walking.

Parameters:
new_shoulder_pitch_median new shoulder_pitch_median value

Definition at line 1407 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::shoulder_pitch_amplitude (  )  const

Get shoulder_pitch_amplitude value.

Amplitude of the shoulder pitch movement during walking.

Returns:
shoulder_pitch_amplitude value

Definition at line 1419 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::SetWalkArmsParamsMessage::shoulder_pitch_median (  )  const

Get shoulder_pitch_median value.

Median in radians of the shoulder pitch during walking.

Returns:
shoulder_pitch_median value

Definition at line 1385 of file HumanoidMotionInterface.cpp.


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1