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

KickMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::KickMessage:

List of all members.

Classes

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

Public Member Functions

 KickMessage (const LegEnum ini_leg, const float ini_strength)
 Constructor with initial values.
 KickMessage ()
 Constructor.
 ~KickMessage ()
 Destructor.
 KickMessage (const KickMessage *m)
 Copy constructor.
LegEnum leg () const
 Get leg value.
void set_leg (const LegEnum new_leg)
 Set leg value.
size_t maxlenof_leg () const
 Get maximum length of leg value.
float strength () const
 Get strength value.
void set_strength (const float new_strength)
 Set strength value.
size_t maxlenof_strength () const
 Get maximum length of strength value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::KickMessage::KickMessage ( const LegEnum  ini_leg,
const float  ini_strength 
)
fawkes::HumanoidMotionInterface::KickMessage::~KickMessage ( )

Destructor.

Definition at line 949 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::HumanoidMotionInterface::KickMessage::KickMessage ( const KickMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 957 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

HumanoidMotionInterface::LegEnum fawkes::HumanoidMotionInterface::KickMessage::leg ( ) const

Get leg value.

Leg to kick with

Returns:
leg value

Definition at line 972 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::KickMessage::maxlenof_leg ( ) const

Get maximum length of leg value.

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

Definition at line 982 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::KickMessage::maxlenof_strength ( ) const

Get maximum length of strength value.

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

Definition at line 1012 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::KickMessage::set_leg ( const LegEnum  new_leg)

Set leg value.

Leg to kick with

Parameters:
new_legnew leg value

Definition at line 992 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::KickMessage::set_strength ( const float  new_strength)

Set strength value.

Kick strength

Parameters:
new_strengthnew strength value

Definition at line 1022 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::KickMessage::strength ( ) const

Get strength value.

Kick strength

Returns:
strength value

Definition at line 1002 of file HumanoidMotionInterface.cpp.


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