DriveRPMMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::DriveRPMMessage:

Classes
struct	DriveRPMMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	DriveRPMMessage (const float ini_front_right, const float ini_front_left, const float ini_rear)
	Constructor with initial values.
	DriveRPMMessage ()
	Constructor.
	~DriveRPMMessage ()
	Destructor.
	DriveRPMMessage (const DriveRPMMessage *m)
	Copy constructor.
float	front_right () const
	Get front_right value.
void	set_front_right (const float new_front_right)
	Set front_right value.
size_t	maxlenof_front_right () const
	Get maximum length of front_right value.
float	front_left () const
	Get front_left value.
void	set_front_left (const float new_front_left)
	Set front_left value.
size_t	maxlenof_front_left () const
	Get maximum length of front_left value.
float	rear () const
	Get rear value.
void	set_rear (const float new_rear)
	Set rear value.
size_t	maxlenof_rear () const
	Get maximum length of rear 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

DriveRPMMessage Fawkes BlackBoard Interface Message.

Definition at line 196 of file MotorInterface.h.

Constructor & Destructor Documentation

fawkes::MotorInterface::DriveRPMMessage::DriveRPMMessage	(	const float	ini_front_right,
		const float	ini_front_left,
		const float	ini_rear
	)

Constructor with initial values.

Parameters:

ini_front_right	initial value for front_right
ini_front_left	initial value for front_left
ini_rear	initial value for rear

Definition at line 939 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::DriveRPMMessage::DriveRPMMessage ( )

Constructor.

Definition at line 954 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::DriveRPMMessage::~DriveRPMMessage ( )

Destructor.

Definition at line 967 of file MotorInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 975 of file MotorInterface.cpp.

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

Member Function Documentation

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

float fawkes::MotorInterface::DriveRPMMessage::front_left ( ) const

Get front_left value.

Rotation in RPM of the left front wheel.

Returns:: front_left value

Definition at line 1020 of file MotorInterface.cpp.

float fawkes::MotorInterface::DriveRPMMessage::front_right ( ) const

Get front_right value.

Rotation in RPM of the right front wheel.

Returns:: front_right value

Definition at line 990 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_front_left ( ) const

Get maximum length of front_left value.

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

Definition at line 1030 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_front_right ( ) const

Get maximum length of front_right value.

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

Definition at line 1000 of file MotorInterface.cpp.

size_t fawkes::MotorInterface::DriveRPMMessage::maxlenof_rear ( ) const

Get maximum length of rear value.

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

Definition at line 1060 of file MotorInterface.cpp.

float fawkes::MotorInterface::DriveRPMMessage::rear ( ) const

Get rear value.

Rotation in RPM of the rear wheel.

Returns:: rear value

Definition at line 1050 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_front_left ( const float new_front_left )

Set front_left value.

Rotation in RPM of the left front wheel.

Parameters:

new_front_left new front_left value

Definition at line 1040 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_front_right ( const float new_front_right )

Set front_right value.

Rotation in RPM of the right front wheel.

Parameters:

new_front_right new front_right value

Definition at line 1010 of file MotorInterface.cpp.

void fawkes::MotorInterface::DriveRPMMessage::set_rear ( const float new_rear )

Set rear value.

Rotation in RPM of the rear wheel.

Parameters:

new_rear new rear value

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