ResetMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::LocalizerControlInterface::ResetMessage:

Classes
struct	ResetMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	ResetMessage (const float ini_x, const float ini_y, const float ini_ori, const float ini_variance)
	Constructor with initial values.
	ResetMessage ()
	Constructor.
	~ResetMessage ()
	Destructor.
	ResetMessage (const ResetMessage *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	ori () const
	Get ori value.
void	set_ori (const float new_ori)
	Set ori value.
size_t	maxlenof_ori () const
	Get maximum length of ori value.
float	variance () const
	Get variance value.
void	set_variance (const float new_variance)
	Set variance value.
size_t	maxlenof_variance () const
	Get maximum length of variance 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

ResetMessage Fawkes BlackBoard Interface Message.

Definition at line 56 of file LocalizerControlInterface.h.

Constructor & Destructor Documentation

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage	(	const float	ini_x,
		const float	ini_y,
		const float	ini_ori,
		const float	ini_variance
	)

Constructor with initial values.

Parameters:

ini_x	initial value for x
ini_y	initial value for y
ini_ori	initial value for ori
ini_variance	initial value for variance

Definition at line 145 of file LocalizerControlInterface.cpp.

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

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage ( )

Constructor.

Definition at line 162 of file LocalizerControlInterface.cpp.

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

fawkes::LocalizerControlInterface::ResetMessage::~ResetMessage ( )

Destructor.

Definition at line 176 of file LocalizerControlInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::LocalizerControlInterface::ResetMessage::ResetMessage ( const ResetMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 184 of file LocalizerControlInterface.cpp.

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

Member Function Documentation

Message * fawkes::LocalizerControlInterface::ResetMessage::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 320 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::maxlenof_ori ( ) const

Get maximum length of ori value.

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

Definition at line 269 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::maxlenof_variance ( ) const

Get maximum length of variance value.

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

Definition at line 299 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::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 209 of file LocalizerControlInterface.cpp.

size_t fawkes::LocalizerControlInterface::ResetMessage::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 239 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::ori ( ) const

Get ori value.

The new initial orientation.

Returns:: ori value

Definition at line 259 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_ori ( const float new_ori )

Set ori value.

The new initial orientation.

Parameters:

new_ori new ori value

Definition at line 279 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_variance ( const float new_variance )

Set variance value.

The variance for the reset position.

Parameters:

new_variance new variance value

Definition at line 309 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_x ( const float new_x )

Set x value.

The new initial x-coordinate.

Parameters:

new_x new x value

Definition at line 219 of file LocalizerControlInterface.cpp.

void fawkes::LocalizerControlInterface::ResetMessage::set_y ( const float new_y )

Set y value.

The new initial x-coordinate.

Parameters:

new_y new y value

Definition at line 249 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::variance ( ) const

Get variance value.

The variance for the reset position.

Returns:: variance value

Definition at line 289 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::x ( ) const

Get x value.

The new initial x-coordinate.

Returns:: x value

Definition at line 199 of file LocalizerControlInterface.cpp.

float fawkes::LocalizerControlInterface::ResetMessage::y ( ) const

Get y value.

The new initial x-coordinate.

Returns:: y value

Definition at line 229 of file LocalizerControlInterface.cpp.

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

src/libs/interfaces/LocalizerControlInterface.h
src/libs/interfaces/LocalizerControlInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation