WalkVelocityMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkVelocityMessage:

Classes
struct	WalkVelocityMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	WalkVelocityMessage (const float ini_x, const float ini_y, const float ini_theta, const float ini_speed)
	Constructor with initial values.
	WalkVelocityMessage ()
	Constructor.
	~WalkVelocityMessage ()
	Destructor.
	WalkVelocityMessage (const WalkVelocityMessage *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.
Public Member Functions inherited from fawkes::Message
	Message (const char *type)
	Constructor.
	Message (const Message *mesg)
	Copy constructor.
	Message (const Message &mesg)
	Copy constructor.
virtual	~Message ()
	Destructor.
Message &	operator= (const Message &m)
	Assign this message to given message.
unsigned int	id () const
	Get message ID.
void	set_id (unsigned int message_id)
	Set message ID.
void	mark_enqueued ()
	Mark message as being enqueued.
bool	enqueued () const
	Check is message has been enqueued.
const Time *	time_enqueued () const
	Get time when message was enqueued.
unsigned int	sender_id () const
	Get ID of sender.
const char *	sender_thread_name () const
	Get sender of message.
Interface *	interface () const
	Get transmitting interface.
const char *	type () const
	Get message type.
InterfaceFieldIterator	fields ()
	Get iterator over all fields of this interface instance.
InterfaceFieldIterator	fields_end ()
	Invalid iterator.
unsigned int	num_fields () const
	Get the number of fields in the message.
const void *	datachunk () const
	Get pointer to data.
unsigned int	datasize () const
	Get size of data.
unsigned int	hops () const
	Get number of hops.
void	set_hops (unsigned int hops)
	Set number of hops.
void	set_from_chunk (const void *chunk)
	Set from raw data chunk.
unsigned int	recipient () const
	Get recipient memory serial.
template<class MessageType >
bool	is_of_type ()
	Check if message has desired type.
Public Member Functions inherited from fawkes::RefCount
	RefCount ()
	Constructor.
virtual	~RefCount ()
	Destructor.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count and conditionally delete this instance.
unsigned int	refcount ()
	Get reference count for this instance.

Additional Inherited Members
Protected Member Functions inherited from fawkes::Message
void	add_fieldinfo (interface_fieldtype_t type, const char name, size_t length, void value, const char *enumtype=0)
	Add an entry to the info list.
Protected Attributes inherited from fawkes::Message
void *	data_ptr
	Pointer to memory that contains local data.
unsigned int	data_size
	Size of memory needed to hold all data.
message_data_ts_t *	data_ts
	data timestamp aliasing pointer

Detailed Description

WalkVelocityMessage Fawkes BlackBoard Interface Message.

Definition at line 184 of file HumanoidMotionInterface.h.

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::WalkVelocityMessage::WalkVelocityMessage	(	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 628 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::WalkVelocityMessage::WalkVelocityMessage ( )

Constructor.

Definition at line 645 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::WalkVelocityMessage::~WalkVelocityMessage ( )

Destructor.

Definition at line 659 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 667 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

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

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

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

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

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

void fawkes::HumanoidMotionInterface::WalkVelocityMessage::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 808 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkVelocityMessage::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 774 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkVelocityMessage::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 706 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::WalkVelocityMessage::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 740 of file HumanoidMotionInterface.cpp.

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

Get speed value.

Fraction of MaxStepFrequency [0.0 to 1.0].

Returns:: speed value

Definition at line 786 of file HumanoidMotionInterface.cpp.

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

Get theta value.

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

Returns:: theta value

Definition at line 752 of file HumanoidMotionInterface.cpp.

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

Get x value.

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

Returns:: x value

Definition at line 684 of file HumanoidMotionInterface.cpp.

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

Get y value.

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

Returns:: y value

Definition at line 718 of file HumanoidMotionInterface.cpp.

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

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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation