fawkes::HumanoidMotionInterface::WalkArcMessage Class Reference

WalkArcMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkArcMessage:

List of all members.

Classes
struct	WalkArcMessage_data_t
	Internal data storage, do NOT modify!
Public Member Functions
	WalkArcMessage (const float ini_angle, const float ini_radius, const uint32_t ini_num_samples)
	Constructor with initial values.
	WalkArcMessage ()
	Constructor.
	~WalkArcMessage ()
	Destructor.
	WalkArcMessage (const WalkArcMessage *m)
	Copy constructor.
float	angle () const
	Get angle value.
void	set_angle (const float new_angle)
	Set angle value.
size_t	maxlenof_angle () const
	Get maximum length of angle value.
float	radius () const
	Get radius value.
void	set_radius (const float new_radius)
	Set radius value.
size_t	maxlenof_radius () const
	Get maximum length of radius 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

WalkArcMessage Fawkes BlackBoard Interface Message.

Definition at line 359 of file HumanoidMotionInterface.h.

---

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::WalkArcMessage::WalkArcMessage	(	const float	ini_angle,
		const float	ini_radius,
		const uint32_t	ini_num_samples
	)

Constructor with initial values.

Parameters:

	ini_angle	initial value for angle
	ini_radius	initial value for radius
	ini_num_samples	initial value for num_samples

Definition at line 1838 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::WalkArcMessage::WalkArcMessage

(

)

Constructor.

Definition at line 1853 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::WalkArcMessage::~WalkArcMessage

(

)

Destructor.

Definition at line 1866 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::WalkArcMessage::WalkArcMessage

(

const WalkArcMessage *

m

)

Copy constructor.

Parameters:

m

message to copy from

Definition at line 1874 of file HumanoidMotionInterface.cpp.

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

---

Member Function Documentation

float fawkes::HumanoidMotionInterface::WalkArcMessage::angle

(

)

const

Get angle value.

Angle in radians to turn over the way.

Returns:

angle value

Definition at line 1889 of file HumanoidMotionInterface.cpp.

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

References WalkArcMessage().

size_t fawkes::HumanoidMotionInterface::WalkArcMessage::maxlenof_angle

(

)

const

Get maximum length of angle value.

Returns:

length of angle value, can be length of the array or number of maximum number of characters for a string

Definition at line 1899 of file HumanoidMotionInterface.cpp.

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

size_t fawkes::HumanoidMotionInterface::WalkArcMessage::maxlenof_radius

(

)

const

Get maximum length of radius value.

Returns:

length of radius value, can be length of the array or number of maximum number of characters for a string

Definition at line 1929 of file HumanoidMotionInterface.cpp.

uint32_t fawkes::HumanoidMotionInterface::WalkArcMessage::num_samples

(

)

const

Get num_samples value.

Number of intermediate samples to use for walking.

Returns:

num_samples value

Definition at line 1951 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::WalkArcMessage::radius

(

)

const

Get radius value.

Radius in m of the circle in m.

Returns:

radius value

Definition at line 1919 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkArcMessage::set_angle

(

const float

new_angle

)

Set angle value.

Angle in radians to turn over the way.

Parameters:

new_angle

new angle value

Definition at line 1909 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkArcMessage::set_num_samples

(

const uint32_t

new_num_samples

)

Set num_samples value.

Number of intermediate samples to use for walking.

Parameters:

new_num_samples

new num_samples value

Definition at line 1973 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkArcMessage::set_radius

(

const float

new_radius

)

Set radius value.

Radius in m of the circle in m.

Parameters:

new_radius

new radius value

Definition at line 1939 of file HumanoidMotionInterface.cpp.

---

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

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