Fawkes API Fawkes Development Version

fawkes::HumanoidMotionInterface::WalkStraightMessage Class Reference

WalkStraightMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkStraightMessage:

List of all members.

Classes

struct  WalkStraightMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 WalkStraightMessage (const float ini_distance, const uint32_t ini_num_samples)
 Constructor with initial values.
 WalkStraightMessage ()
 Constructor.
 ~WalkStraightMessage ()
 Destructor.
 WalkStraightMessage (const WalkStraightMessage *m)
 Copy constructor.
float distance () const
 Get distance value.
void set_distance (const float new_distance)
 Set distance value.
size_t maxlenof_distance () const
 Get maximum length of distance 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::WalkStraightMessage::WalkStraightMessage ( const float  ini_distance,
const uint32_t  ini_num_samples 
)

Constructor with initial values.

Parameters:
ini_distanceinitial value for distance
ini_num_samplesinitial value for num_samples

Definition at line 1581 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::WalkStraightMessage::WalkStraightMessage ( )
fawkes::HumanoidMotionInterface::WalkStraightMessage::~WalkStraightMessage ( )

Destructor.

Definition at line 1606 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::HumanoidMotionInterface::WalkStraightMessage::WalkStraightMessage ( const WalkStraightMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 1614 of file HumanoidMotionInterface.cpp.

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


Member Function Documentation

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

float fawkes::HumanoidMotionInterface::WalkStraightMessage::distance ( ) const

Get distance value.

Distance in m to walk.

Returns:
distance value

Definition at line 1629 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::WalkStraightMessage::maxlenof_distance ( ) const

Get maximum length of distance value.

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

Definition at line 1639 of file HumanoidMotionInterface.cpp.

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

uint32_t fawkes::HumanoidMotionInterface::WalkStraightMessage::num_samples ( ) const

Get num_samples value.

Number of intermediate samples to use for walking.

Returns:
num_samples value

Definition at line 1661 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkStraightMessage::set_distance ( const float  new_distance)

Set distance value.

Distance in m to walk.

Parameters:
new_distancenew distance value

Definition at line 1649 of file HumanoidMotionInterface.cpp.

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

Set num_samples value.

Number of intermediate samples to use for walking.

Parameters:
new_num_samplesnew num_samples value

Definition at line 1683 of file HumanoidMotionInterface.cpp.


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