MoveHeadMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::MoveHeadMessage:

Classes
struct	MoveHeadMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	MoveHeadMessage (const float ini_yaw, const float ini_pitch, const float ini_speed)
	Constructor with initial values.
	MoveHeadMessage ()
	Constructor.
	~MoveHeadMessage ()
	Destructor.
	MoveHeadMessage (const MoveHeadMessage *m)
	Copy constructor.
float	yaw () const
	Get yaw value.
void	set_yaw (const float new_yaw)
	Set yaw value.
size_t	maxlenof_yaw () const
	Get maximum length of yaw value.
float	pitch () const
	Get pitch value.
void	set_pitch (const float new_pitch)
	Set pitch value.
size_t	maxlenof_pitch () const
	Get maximum length of pitch 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

MoveHeadMessage Fawkes BlackBoard Interface Message.

Definition at line 360 of file HumanoidMotionInterface.h.

Constructor & Destructor Documentation

fawkes::HumanoidMotionInterface::MoveHeadMessage::MoveHeadMessage	(	const float	ini_yaw,
		const float	ini_pitch,
		const float	ini_speed
	)

Constructor with initial values.

Parameters:

ini_yaw	initial value for yaw
ini_pitch	initial value for pitch
ini_speed	initial value for speed

Definition at line 1231 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::MoveHeadMessage::MoveHeadMessage ( )

Constructor.

Definition at line 1246 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::MoveHeadMessage::~MoveHeadMessage ( )

Destructor.

Definition at line 1259 of file HumanoidMotionInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1267 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

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

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_pitch ( ) const

Get maximum length of pitch value.

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

Definition at line 1322 of file HumanoidMotionInterface.cpp.

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

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_yaw ( ) const

Get maximum length of yaw value.

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

Definition at line 1292 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::MoveHeadMessage::pitch ( ) const

Get pitch value.

Desired pitch (vertical orientation).

Returns:: pitch value

Definition at line 1312 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_pitch ( const float new_pitch )

Set pitch value.

Desired pitch (vertical orientation).

Parameters:

new_pitch new pitch value

Definition at line 1332 of file HumanoidMotionInterface.cpp.

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

Set speed value.

Maximum speed in [0.0..1.0].

Parameters:

new_speed new speed value

Definition at line 1362 of file HumanoidMotionInterface.cpp.

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_yaw ( const float new_yaw )

Set yaw value.

Desired yaw (horizontal orientation).

Parameters:

new_yaw new yaw value

Definition at line 1302 of file HumanoidMotionInterface.cpp.

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

Get speed value.

Maximum speed in [0.0..1.0].

Returns:: speed value

Definition at line 1342 of file HumanoidMotionInterface.cpp.

float fawkes::HumanoidMotionInterface::MoveHeadMessage::yaw ( ) const

Get yaw value.

Desired yaw (horizontal orientation).

Returns:: yaw value

Definition at line 1282 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