fawkes::MotorInterface::GotoMessage Class Reference

GotoMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::GotoMessage:

Classes
struct	GotoMessage_data_t
	Internal data storage, do NOT modify!
Public Member Functions
	GotoMessage (const float ini_x, const float ini_y, const float ini_phi, const float ini_time_sec)
	Constructor with initial values.
	GotoMessage ()
	Constructor.
	~GotoMessage ()
	Destructor.
	GotoMessage (const GotoMessage *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	phi () const
	Get phi value.
void	set_phi (const float new_phi)
	Set phi value.
size_t	maxlenof_phi () const
	Get maximum length of phi value.
float	time_sec () const
	Get time_sec value.
void	set_time_sec (const float new_time_sec)
	Set time_sec value.
size_t	maxlenof_time_sec () const
	Get maximum length of time_sec value.
virtual Message *	clone () const
	Clone this message.

Detailed Description

GotoMessage Fawkes BlackBoard Interface Message.

Definition at line 231 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::GotoMessage::GotoMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_phi,
		const float	ini_time_sec
	)

Constructor with initial values.

Parameters:

	ini_x	initial value for x
	ini_y	initial value for y
	ini_phi	initial value for phi
	ini_time_sec	initial value for time_sec

Definition at line 1098 of file MotorInterface.cpp.

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

fawkes::MotorInterface::GotoMessage::GotoMessage ( )

Constructor.

Definition at line 1115 of file MotorInterface.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::MotorInterface::GotoMessage::~GotoMessage ( )

Destructor.

Definition at line 1129 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::MotorInterface::GotoMessage::GotoMessage ( const GotoMessage * m )

Copy constructor.

Parameters:

m

message to copy from

Definition at line 1137 of file MotorInterface.cpp.

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

Member Function Documentation

Message * fawkes::MotorInterface::GotoMessage::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 1273 of file MotorInterface.cpp.

References GotoMessage().

size_t fawkes::MotorInterface::GotoMessage::maxlenof_phi ( ) const

Get maximum length of phi value.

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

Definition at line 1222 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::GotoMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

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

Definition at line 1252 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::GotoMessage::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 1162 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::GotoMessage::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 1192 of file MotorInterface.cpp.

float fawkes::MotorInterface::GotoMessage::phi ( ) const

Get phi value.

Angle relative to current angle in rad.

Returns:: phi value

Definition at line 1212 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

void fawkes::MotorInterface::GotoMessage::set_phi ( const float new_phi )

Set phi value.

Angle relative to current angle in rad.

Parameters:

new_phi

new phi value

Definition at line 1232 of file MotorInterface.cpp.

void fawkes::MotorInterface::GotoMessage::set_time_sec ( const float new_time_sec )

Set time_sec value.

When to reach the desired location.

Parameters:

new_time_sec

new time_sec value

Definition at line 1262 of file MotorInterface.cpp.

void fawkes::MotorInterface::GotoMessage::set_x ( const float new_x )

Set x value.

X distance in m.

Parameters:

new_x

new x value

Definition at line 1172 of file MotorInterface.cpp.

void fawkes::MotorInterface::GotoMessage::set_y ( const float new_y )

Set y value.

Y distance in m.

Parameters:

new_y

new y value

Definition at line 1202 of file MotorInterface.cpp.

float fawkes::MotorInterface::GotoMessage::time_sec ( ) const

Get time_sec value.

When to reach the desired location.

Returns:: time_sec value

Definition at line 1242 of file MotorInterface.cpp.

float fawkes::MotorInterface::GotoMessage::x ( ) const

Get x value.

X distance in m.

Returns:: x value

Definition at line 1152 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

float fawkes::MotorInterface::GotoMessage::y ( ) const

Get y value.

Y distance in m.

Returns:: y value

Definition at line 1182 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

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

src/interfaces/MotorInterface.h
src/interfaces/MotorInterface.cpp

fawkes::MotorInterface::GotoMessage Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation