LinTransRotMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::LinTransRotMessage:

Classes
struct	LinTransRotMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	LinTransRotMessage (const float ini_vx, const float ini_vy, const float ini_omega)
	Constructor with initial values.
	LinTransRotMessage ()
	Constructor.
	~LinTransRotMessage ()
	Destructor.
	LinTransRotMessage (const LinTransRotMessage *m)
	Copy constructor.
float	vx () const
	Get vx value.
void	set_vx (const float new_vx)
	Set vx value.
size_t	maxlenof_vx () const
	Get maximum length of vx value.
float	vy () const
	Get vy value.
void	set_vy (const float new_vy)
	Set vy value.
size_t	maxlenof_vy () const
	Get maximum length of vy 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

LinTransRotMessage Fawkes BlackBoard Interface Message.

Definition at line 398 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::LinTransRotMessage::LinTransRotMessage	(	const float	ini_vx,
		const float	ini_vy,
		const float	ini_omega
	)

Constructor with initial values.

Parameters:

ini_vx	initial value for vx
ini_vy	initial value for vy
ini_omega	initial value for omega

Definition at line 1819 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::LinTransRotMessage::LinTransRotMessage ( )

Constructor.

Definition at line 1834 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::LinTransRotMessage::~LinTransRotMessage ( )

Destructor.

Definition at line 1847 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1855 of file MotorInterface.cpp.

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

Member Function Documentation

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

size_t fawkes::MotorInterface::LinTransRotMessage::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 1940 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::LinTransRotMessage::maxlenof_vx ( ) const

Get maximum length of vx value.

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

Definition at line 1880 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::LinTransRotMessage::maxlenof_vy ( ) const

Get maximum length of vy value.

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

Definition at line 1910 of file MotorInterface.cpp.

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

Get omega value.

Rotational speed in rad/s.

Returns:: omega value

Definition at line 1930 of file MotorInterface.cpp.

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

Set omega value.

Rotational speed in rad/s.

Parameters:

new_omega new omega value

Definition at line 1950 of file MotorInterface.cpp.

void fawkes::MotorInterface::LinTransRotMessage::set_vx ( const float new_vx )

Set vx value.

Speed for translation in X direction in m/s.

Parameters:

new_vx new vx value

Definition at line 1890 of file MotorInterface.cpp.

void fawkes::MotorInterface::LinTransRotMessage::set_vy ( const float new_vy )

Set vy value.

Speed for translation in Y direction in m/s.

Parameters:

new_vy new vy value

Definition at line 1920 of file MotorInterface.cpp.

float fawkes::MotorInterface::LinTransRotMessage::vx ( ) const

Get vx value.

Speed for translation in X direction in m/s.

Returns:: vx value

Definition at line 1870 of file MotorInterface.cpp.

float fawkes::MotorInterface::LinTransRotMessage::vy ( ) const

Get vy value.

Speed for translation in Y direction in m/s.

Returns:: vy value

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