OrbitMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::OrbitMessage:

Classes
struct	OrbitMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	OrbitMessage (const float ini_px, const float ini_py, const float ini_omega)
	Constructor with initial values.
	OrbitMessage ()
	Constructor.
	~OrbitMessage ()
	Destructor.
	OrbitMessage (const OrbitMessage *m)
	Copy constructor.
float	px () const
	Get px value.
void	set_px (const float new_px)
	Set px value.
size_t	maxlenof_px () const
	Get maximum length of px value.
float	py () const
	Get py value.
void	set_py (const float new_py)
	Set py value.
size_t	maxlenof_py () const
	Get maximum length of py value.
float	omega () const
	Get omega value.
void	set_omega (const float new_omega)
	Set omega value.
size_t	maxlenof_omega () const
	Get maximum length of omega 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

OrbitMessage Fawkes BlackBoard Interface Message.

Definition at line 363 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::OrbitMessage::OrbitMessage	(	const float	ini_px,
		const float	ini_py,
		const float	ini_omega
	)

Constructor with initial values.

Parameters:

ini_px	initial value for px
ini_py	initial value for py
ini_omega	initial value for omega

Definition at line 1661 of file MotorInterface.cpp.

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

fawkes::MotorInterface::OrbitMessage::OrbitMessage ( )

Constructor.

Definition at line 1676 of file MotorInterface.cpp.

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

fawkes::MotorInterface::OrbitMessage::~OrbitMessage ( )

Destructor.

Definition at line 1689 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::MotorInterface::OrbitMessage::OrbitMessage ( const OrbitMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1697 of file MotorInterface.cpp.

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

Member Function Documentation

Message * fawkes::MotorInterface::OrbitMessage::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 1803 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::OrbitMessage::maxlenof_omega ( ) const

Get maximum length of omega value.

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

Definition at line 1782 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::OrbitMessage::maxlenof_px ( ) const

Get maximum length of px value.

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

Definition at line 1722 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::OrbitMessage::maxlenof_py ( ) const

Get maximum length of py value.

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

Definition at line 1752 of file MotorInterface.cpp.

float fawkes::MotorInterface::OrbitMessage::omega ( ) const

Get omega value.

Angular speed around point in rad/s.

Returns:: omega value

Definition at line 1772 of file MotorInterface.cpp.

float fawkes::MotorInterface::OrbitMessage::px ( ) const

Get px value.

Point's X coordinate to orbit.

Returns:: px value

Definition at line 1712 of file MotorInterface.cpp.

float fawkes::MotorInterface::OrbitMessage::py ( ) const

Get py value.

Point's Y coordinate to orbit.

Returns:: py value

Definition at line 1742 of file MotorInterface.cpp.

void fawkes::MotorInterface::OrbitMessage::set_omega ( const float new_omega )

Set omega value.

Angular speed around point in rad/s.

Parameters:

new_omega new omega value

Definition at line 1792 of file MotorInterface.cpp.

void fawkes::MotorInterface::OrbitMessage::set_px ( const float new_px )

Set px value.

Point's X coordinate to orbit.

Parameters:

new_px new px value

Definition at line 1732 of file MotorInterface.cpp.

void fawkes::MotorInterface::OrbitMessage::set_py ( const float new_py )

Set py value.

Point's Y coordinate to orbit.

Parameters:

new_py new py value

Definition at line 1762 of file MotorInterface.cpp.

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

src/libs/interfaces/MotorInterface.h
src/libs/interfaces/MotorInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation