WalkArcMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkArcMessage:

Classes
struct	WalkArcMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	WalkArcMessage (const float ini_angle, const float ini_radius)
	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.
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

WalkArcMessage Fawkes BlackBoard Interface Message.

Definition at line 153 of file HumanoidMotionInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:

ini_angle	initial value for angle
ini_radius	initial value for radius

Definition at line 502 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::WalkArcMessage::WalkArcMessage ( )

Constructor.

Definition at line 515 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::WalkArcMessage::~WalkArcMessage ( )

Destructor.

Definition at line 527 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 535 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 550 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 611 of file HumanoidMotionInterface.cpp.

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 560 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 590 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 580 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 570 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 600 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