TimedGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::TimedGotoMessage:

Classes
struct	TimedGotoMessage_data_t
	Internal data storage, do NOT modify!

Public Member Functions
	TimedGotoMessage (const float ini_time_sec, const float ini_pan, const float ini_tilt)
	Constructor with initial values.
	TimedGotoMessage ()
	Constructor.
	~TimedGotoMessage ()
	Destructor.
	TimedGotoMessage (const TimedGotoMessage *m)
	Copy constructor.
float	time_sec () const
	Get time_sec value.
void	set_time_sec (const float new_time_sec)
	Set time_sec value.
size_t	maxlenof_time_sec () const
	Get maximum length of time_sec value.
float	pan () const
	Get pan value.
void	set_pan (const float new_pan)
	Set pan value.
size_t	maxlenof_pan () const
	Get maximum length of pan value.
float	tilt () const
	Get tilt value.
void	set_tilt (const float new_tilt)
	Set tilt value.
size_t	maxlenof_tilt () const
	Get maximum length of tilt 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

TimedGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 204 of file PanTiltInterface.h.

Constructor & Destructor Documentation

fawkes::PanTiltInterface::TimedGotoMessage::TimedGotoMessage	(	const float	ini_time_sec,
		const float	ini_pan,
		const float	ini_tilt
	)

Constructor with initial values.

Parameters:

ini_time_sec	initial value for time_sec
ini_pan	initial value for pan
ini_tilt	initial value for tilt

Definition at line 1042 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::TimedGotoMessage::TimedGotoMessage ( )

Constructor.

Definition at line 1057 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::TimedGotoMessage::~TimedGotoMessage ( )

Destructor.

Definition at line 1070 of file PanTiltInterface.cpp.

References fawkes::Interface::data_ptr.

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

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1078 of file PanTiltInterface.cpp.

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

Member Function Documentation

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

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_pan ( ) const

Get maximum length of pan value.

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

Definition at line 1135 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_tilt ( ) const

Get maximum length of tilt value.

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

Definition at line 1165 of file PanTiltInterface.cpp.

size_t fawkes::PanTiltInterface::TimedGotoMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

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

Definition at line 1104 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::TimedGotoMessage::pan ( ) const

Get pan value.

Current pan.

Returns:: pan value

Definition at line 1125 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

void fawkes::PanTiltInterface::TimedGotoMessage::set_pan ( const float new_pan )

Set pan value.

Current pan.

Parameters:

new_pan new pan value

Definition at line 1145 of file PanTiltInterface.cpp.

void fawkes::PanTiltInterface::TimedGotoMessage::set_tilt ( const float new_tilt )

Set tilt value.

Current tilt.

Parameters:

new_tilt new tilt value

Definition at line 1175 of file PanTiltInterface.cpp.

void fawkes::PanTiltInterface::TimedGotoMessage::set_time_sec ( const float new_time_sec )

Set time_sec value.

Time in seconds when to reach the final position.

Parameters:

new_time_sec new time_sec value

Definition at line 1115 of file PanTiltInterface.cpp.

float fawkes::PanTiltInterface::TimedGotoMessage::tilt ( ) const

Get tilt value.

Current tilt.

Returns:: tilt value

Definition at line 1155 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

float fawkes::PanTiltInterface::TimedGotoMessage::time_sec ( ) const

Get time_sec value.

Time in seconds when to reach the final position.

Returns:: time_sec value

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