CartesianGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::CartesianGotoMessage:

Classes
struct	CartesianGotoMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	CartesianGotoMessage (const float ini_x, const float ini_y, const float ini_orientation)
	Constructor with initial values.
	CartesianGotoMessage ()
	Constructor.
	~CartesianGotoMessage ()
	Destructor.
	CartesianGotoMessage (const CartesianGotoMessage *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	orientation () const
	Get orientation value.
void	set_orientation (const float new_orientation)
	Set orientation value.
size_t	maxlenof_orientation () const
	Get maximum length of orientation 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

CartesianGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 141 of file NavigatorInterface.h.

Constructor & Destructor Documentation

fawkes::NavigatorInterface::CartesianGotoMessage::CartesianGotoMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_orientation
	)

Constructor with initial values.

Parameters:

ini_x	initial value for x
ini_y	initial value for y
ini_orientation	initial value for orientation

Definition at line 773 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::CartesianGotoMessage::CartesianGotoMessage ( )

Constructor.

Definition at line 788 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::CartesianGotoMessage::~CartesianGotoMessage ( )

Destructor.

Definition at line 801 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 809 of file NavigatorInterface.cpp.

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

Member Function Documentation

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

size_t fawkes::NavigatorInterface::CartesianGotoMessage::maxlenof_orientation ( ) const

Get maximum length of orientation value.

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

Definition at line 894 of file NavigatorInterface.cpp.

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

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

float fawkes::NavigatorInterface::CartesianGotoMessage::orientation ( ) const

Get orientation value.

The orientation of the robot at the target.

Returns:: orientation value

Definition at line 884 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::CartesianGotoMessage::set_orientation ( const float new_orientation )

Set orientation value.

The orientation of the robot at the target.

Parameters:

new_orientation new orientation value

Definition at line 904 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::CartesianGotoMessage::set_x ( const float new_x )

Set x value.

X-coordinate of the target, in the robot's coordinate system.

Parameters:

new_x new x value

Definition at line 844 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::CartesianGotoMessage::set_y ( const float new_y )

Set y value.

Y-coordinate of the target, in the robot's coordinate system.

Parameters:

new_y new y value

Definition at line 874 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::CartesianGotoMessage::x ( ) const

Get x value.

X-coordinate of the target, in the robot's coordinate system.

Returns:: x value

Definition at line 824 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::CartesianGotoMessage::y ( ) const

Get y value.

Y-coordinate of the target, in the robot's coordinate system.

Returns:: y value

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