MoveObjectMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::OpenRaveInterface::MoveObjectMessage:

Classes
struct	MoveObjectMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	MoveObjectMessage (const char *ini_name, const float ini_x, const float ini_y, const float ini_z)
	Constructor with initial values.
	MoveObjectMessage ()
	Constructor.
	~MoveObjectMessage ()
	Destructor.
	MoveObjectMessage (const MoveObjectMessage *m)
	Copy constructor.
char *	name () const
	Get name value.
void	set_name (const char *new_name)
	Set name value.
size_t	maxlenof_name () const
	Get maximum length of name value.
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	z () const
	Get z value.
void	set_z (const float new_z)
	Set z value.
size_t	maxlenof_z () const
	Get maximum length of z 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

MoveObjectMessage Fawkes BlackBoard Interface Message.

Definition at line 196 of file OpenRaveInterface.h.

Constructor & Destructor Documentation

fawkes::OpenRaveInterface::MoveObjectMessage::MoveObjectMessage	(	const char *	ini_name,
		const float	ini_x,
		const float	ini_y,
		const float	ini_z
	)

Constructor with initial values.

Parameters:

ini_name	initial value for name
ini_x	initial value for x
ini_y	initial value for y
ini_z	initial value for z

Definition at line 709 of file OpenRaveInterface.cpp.

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

fawkes::OpenRaveInterface::MoveObjectMessage::MoveObjectMessage ( )

Constructor.

Definition at line 726 of file OpenRaveInterface.cpp.

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

fawkes::OpenRaveInterface::MoveObjectMessage::~MoveObjectMessage ( )

Destructor.

Definition at line 740 of file OpenRaveInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::OpenRaveInterface::MoveObjectMessage::MoveObjectMessage ( const MoveObjectMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 748 of file OpenRaveInterface.cpp.

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

Member Function Documentation

Message * fawkes::OpenRaveInterface::MoveObjectMessage::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 884 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::maxlenof_name ( ) const

Get maximum length of name value.

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

Definition at line 773 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::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 803 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::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 833 of file OpenRaveInterface.cpp.

size_t fawkes::OpenRaveInterface::MoveObjectMessage::maxlenof_z ( ) const

Get maximum length of z value.

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

Definition at line 863 of file OpenRaveInterface.cpp.

char * fawkes::OpenRaveInterface::MoveObjectMessage::name ( ) const

Get name value.

Name of object

Returns:: name value

Definition at line 763 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

void fawkes::OpenRaveInterface::MoveObjectMessage::set_name ( const char * new_name )

Set name value.

Name of object

Parameters:

new_name new name value

Definition at line 783 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_x ( const float new_x )

Set x value.

x position of object (meters)

Parameters:

new_x new x value

Definition at line 813 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_y ( const float new_y )

Set y value.

y position of object (meters)

Parameters:

new_y new y value

Definition at line 843 of file OpenRaveInterface.cpp.

void fawkes::OpenRaveInterface::MoveObjectMessage::set_z ( const float new_z )

Set z value.

z position of object (meters)

Parameters:

new_z new z value

Definition at line 873 of file OpenRaveInterface.cpp.

float fawkes::OpenRaveInterface::MoveObjectMessage::x ( ) const

Get x value.

x position of object (meters)

Returns:: x value

Definition at line 793 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

float fawkes::OpenRaveInterface::MoveObjectMessage::y ( ) const

Get y value.

y position of object (meters)

Returns:: y value

Definition at line 823 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

float fawkes::OpenRaveInterface::MoveObjectMessage::z ( ) const

Get z value.

z position of object (meters)

Returns:: z value

Definition at line 853 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

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

src/libs/interfaces/OpenRaveInterface.h
src/plugins/openrave/interfaces/OpenRaveInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation