WalkMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkMessage:

Classes
struct	WalkMessage_data_t
	Internal data storage, do NOT modify!
Public Member Functions
	WalkMessage (const float ini_x, const float ini_y, const float ini_theta, const float ini_speed)
	Constructor with initial values.
	WalkMessage ()
	Constructor.
	~WalkMessage ()
	Destructor.
	WalkMessage (const WalkMessage *m)
	Copy constructor.
float	x () const
	Get x value.
void	set_x (const float new_x)
	Set x value.
size_t	maxlenof_x () const
	Get maximum length of x value.
float	y () const
	Get y value.
void	set_y (const float new_y)
	Set y value.
size_t	maxlenof_y () const
	Get maximum length of y value.
float	theta () const
	Get theta value.
void	set_theta (const float new_theta)
	Set theta value.
size_t	maxlenof_theta () const
	Get maximum length of theta value.
float	speed () const
	Get speed value.
void	set_speed (const float new_speed)
	Set speed value.
size_t	maxlenof_speed () const
	Get maximum length of speed value.
virtual Message *	clone () const
	Clone this message.

Detailed Description

WalkMessage Fawkes BlackBoard Interface Message.

Definition at line 396 of file HumanoidMotionInterface.h.

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::WalkMessage::WalkMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_theta,
		const float	ini_speed
	)

Constructor with initial values.

Parameters:

	ini_x	initial value for x
	ini_y	initial value for y
	ini_theta	initial value for theta
	ini_speed	initial value for speed

Definition at line 2001 of file HumanoidMotionInterface.cpp.

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

fawkes::HumanoidMotionInterface::WalkMessage::WalkMessage ( )

Constructor.

Definition at line 2018 of file HumanoidMotionInterface.cpp.

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

Referenced by clone().

fawkes::HumanoidMotionInterface::WalkMessage::~WalkMessage ( )

Destructor.

Definition at line 2032 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::HumanoidMotionInterface::WalkMessage::WalkMessage ( const WalkMessage * m )

Copy constructor.

Parameters:

m

message to copy from

Definition at line 2040 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

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

References WalkMessage().

size_t fawkes::HumanoidMotionInterface::WalkMessage::maxlenof_speed ( ) const

Get maximum length of speed value.

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

Definition at line 2155 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::WalkMessage::maxlenof_theta ( ) const

Get maximum length of theta value.

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

Definition at line 2125 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::WalkMessage::maxlenof_x ( ) const

Get maximum length of x value.

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

Definition at line 2065 of file HumanoidMotionInterface.cpp.

size_t fawkes::HumanoidMotionInterface::WalkMessage::maxlenof_y ( ) const

Get maximum length of y value.

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

Definition at line 2095 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkMessage::set_speed ( const float new_speed )

Set speed value.

Fraction of MaxStepFrequency [0.0 to 1.0]

Parameters:

new_speed

new speed value

Definition at line 2165 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkMessage::set_theta ( const float new_theta )

Set theta value.

Fraction of MaxStepTheta. Use negative for clockwise [-1.0 to 1.0]

Parameters:

new_theta

new theta value

Definition at line 2135 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkMessage::set_x ( const float new_x )

Set x value.

Fraction of MaxStepX. Use negative for backwards. [-1.0 to 1.0]

Parameters:

new_x

new x value

Definition at line 2075 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkMessage::set_y ( const float new_y )

Set y value.

Fraction of MaxStepY. Use negative for right. [-1.0 to 1.0]

Parameters:

new_y

new y value

Definition at line 2105 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::WalkMessage::speed ( ) const

Get speed value.

Fraction of MaxStepFrequency [0.0 to 1.0]

Returns:: speed value

Definition at line 2145 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::WalkMessage::theta ( ) const

Get theta value.

Fraction of MaxStepTheta. Use negative for clockwise [-1.0 to 1.0]

Returns:: theta value

Definition at line 2115 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::WalkMessage::x ( ) const

Get x value.

Fraction of MaxStepX. Use negative for backwards. [-1.0 to 1.0]

Returns:: x value

Definition at line 2055 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::WalkMessage::y ( ) const

Get y value.

Fraction of MaxStepY. Use negative for right. [-1.0 to 1.0]

Returns:: y value

Definition at line 2085 of file HumanoidMotionInterface.cpp.

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

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

fawkes::HumanoidMotionInterface::WalkMessage Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation