SetMarginMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::SetMarginMessage:

Classes
struct	SetMarginMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	SetMarginMessage (const float ini_pan_margin, const float ini_tilt_margin)
	Constructor with initial values.
	SetMarginMessage ()
	Constructor.
	~SetMarginMessage ()
	Destructor.
	SetMarginMessage (const SetMarginMessage *m)
	Copy constructor.
float	pan_margin () const
	Get pan_margin value.
void	set_pan_margin (const float new_pan_margin)
	Set pan_margin value.
size_t	maxlenof_pan_margin () const
	Get maximum length of pan_margin value.
float	tilt_margin () const
	Get tilt_margin value.
void	set_tilt_margin (const float new_tilt_margin)
	Set tilt_margin value.
size_t	maxlenof_tilt_margin () const
	Get maximum length of tilt_margin 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

SetMarginMessage Fawkes BlackBoard Interface Message.

Definition at line 298 of file PanTiltInterface.h.

Constructor & Destructor Documentation

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage	(	const float	ini_pan_margin,
		const float	ini_tilt_margin
	)

Constructor with initial values.

Parameters:

ini_pan_margin	initial value for pan_margin
ini_tilt_margin	initial value for tilt_margin

Definition at line 1415 of file PanTiltInterface.cpp.

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

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage ( )

Constructor.

Definition at line 1428 of file PanTiltInterface.cpp.

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

fawkes::PanTiltInterface::SetMarginMessage::~SetMarginMessage ( )

Destructor.

Definition at line 1440 of file PanTiltInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage ( const SetMarginMessage * m )

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1448 of file PanTiltInterface.cpp.

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

Member Function Documentation

Message * fawkes::PanTiltInterface::SetMarginMessage::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 1528 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::SetMarginMessage::maxlenof_pan_margin ( ) const

Get maximum length of pan_margin value.

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

Definition at line 1474 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::SetMarginMessage::maxlenof_tilt_margin ( ) const

Get maximum length of tilt_margin value.

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

Definition at line 1506 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::SetMarginMessage::pan_margin ( ) const

Get pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Returns:: pan_margin value

Definition at line 1464 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

void fawkes::PanTiltInterface::SetMarginMessage::set_pan_margin ( const float new_pan_margin )

Set pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Parameters:

new_pan_margin new pan_margin value

Definition at line 1485 of file PanTiltInterface.cpp.

void fawkes::PanTiltInterface::SetMarginMessage::set_tilt_margin ( const float new_tilt_margin )

Set tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Parameters:

new_tilt_margin new tilt_margin value

Definition at line 1517 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::SetMarginMessage::tilt_margin ( ) const

Get tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Returns:: tilt_margin value

Definition at line 1496 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

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

src/libs/interfaces/PanTiltInterface.h
src/plugins/pantilt/interfaces/PanTiltInterface.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation