fawkes::HumanoidMotionInterface::WalkSidewaysMessage Class Reference

WalkSidewaysMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkSidewaysMessage:

List of all members.

Classes
struct	WalkSidewaysMessage_data_t
	Internal data storage, do NOT modify!
Public Member Functions
	WalkSidewaysMessage (const float ini_distance, const uint32_t ini_num_samples)
	Constructor with initial values.
	WalkSidewaysMessage ()
	Constructor.
	~WalkSidewaysMessage ()
	Destructor.
	WalkSidewaysMessage (const WalkSidewaysMessage *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 Message *	clone () const
	Clone this message.

---

Detailed Description

WalkSidewaysMessage Fawkes BlackBoard Interface Message.

Definition at line 326 of file HumanoidMotionInterface.h.

---

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::WalkSidewaysMessage::WalkSidewaysMessage	(	const float	ini_distance,
		const uint32_t	ini_num_samples
	)

Constructor with initial values.

Parameters:

	ini_distance	initial value for distance
	ini_num_samples	initial value for num_samples

Definition at line 1709 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::WalkSidewaysMessage::WalkSidewaysMessage

(

)

Constructor.

Definition at line 1722 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.

Referenced by clone().

fawkes::HumanoidMotionInterface::WalkSidewaysMessage::~WalkSidewaysMessage

(

)

Destructor.

Definition at line 1734 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::WalkSidewaysMessage::WalkSidewaysMessage

(

const WalkSidewaysMessage *

m

)

Copy constructor.

Parameters:

m

message to copy from

Definition at line 1742 of file HumanoidMotionInterface.cpp.

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

---

Member Function Documentation

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

References WalkSidewaysMessage().

float fawkes::HumanoidMotionInterface::WalkSidewaysMessage::distance

(

)

const

Get distance value.

Distance in m to walk.

Returns:

distance value

Definition at line 1757 of file HumanoidMotionInterface.cpp.

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

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

uint32_t fawkes::HumanoidMotionInterface::WalkSidewaysMessage::num_samples

(

)

const

Get num_samples value.

Number of intermediate samples to use for strafing.

Returns:

num_samples value

Definition at line 1789 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkSidewaysMessage::set_distance

(

const float

new_distance

)

Set distance value.

Distance in m to walk.

Parameters:

new_distance

new distance value

Definition at line 1777 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkSidewaysMessage::set_num_samples

(

const uint32_t

new_num_samples

)

Set num_samples value.

Number of intermediate samples to use for strafing.

Parameters:

new_num_samples

new num_samples value

Definition at line 1811 of file HumanoidMotionInterface.cpp.

---

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

• src/interfaces/HumanoidMotionInterface.h
• src/interfaces/HumanoidMotionInterface.cpp