TurnMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::TurnMessage:

Classes
struct	TurnMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	TurnMessage (const float ini_angle, const float ini_velocity)
	Constructor with initial values.
	TurnMessage ()
	Constructor.
	~TurnMessage ()
	Destructor.
	TurnMessage (const TurnMessage *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	velocity () const
	Get velocity value.
void	set_velocity (const float new_velocity)
	Set velocity value.
size_t	maxlenof_velocity () const
	Get maximum length of velocity 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

TurnMessage Fawkes BlackBoard Interface Message.

Definition at line 109 of file NavigatorInterface.h.

Constructor & Destructor Documentation

fawkes::NavigatorInterface::TurnMessage::TurnMessage	(	const float	ini_angle,
		const float	ini_velocity
	)

Constructor with initial values.

Parameters:

ini_angle	initial value for angle
ini_velocity	initial value for velocity

Definition at line 646 of file NavigatorInterface.cpp.

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

fawkes::NavigatorInterface::TurnMessage::TurnMessage ( )

Constructor.

Definition at line 659 of file NavigatorInterface.cpp.

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

fawkes::NavigatorInterface::TurnMessage::~TurnMessage ( )

Destructor.

Definition at line 671 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NavigatorInterface::TurnMessage::TurnMessage ( const TurnMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 679 of file NavigatorInterface.cpp.

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

Member Function Documentation

float fawkes::NavigatorInterface::TurnMessage::angle ( ) const

Get angle value.

Angle of the turn.

Returns:: angle value

Definition at line 694 of file NavigatorInterface.cpp.

Message * fawkes::NavigatorInterface::TurnMessage::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 757 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::TurnMessage::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 704 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::TurnMessage::maxlenof_velocity ( ) const

Get maximum length of velocity value.

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

Definition at line 735 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::TurnMessage::set_angle ( const float new_angle )

Set angle value.

Angle of the turn.

Parameters:

new_angle new angle value

Definition at line 714 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::TurnMessage::set_velocity ( const float new_velocity )

Set velocity value.

The desired turning velocity in rad/s, set to zero to use default value.

Parameters:

new_velocity new velocity value

Definition at line 746 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::TurnMessage::velocity ( ) const

Get velocity value.

The desired turning velocity in rad/s, set to zero to use default value.

Returns:: velocity value

Definition at line 725 of file NavigatorInterface.cpp.

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

src/libs/interfaces/NavigatorInterface.h
src/libs/interfaces/NavigatorInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation