lti::panTiltUnit::parameters Class Reference

the parameters for the class panTiltUnit More...

#include <ltiPanTiltUnit.h>

Inheritance diagram for lti::panTiltUnit::parameters:

[legend]

Collaboration diagram for lti::panTiltUnit::parameters:

[legend]

List of all members.

Public Types
enum	eAngleFormatType
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	parameters (float minPan, float maxPan, float minTilt, float maxTilt)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eAngleFormatType	angleFormat
float	pan
float	tilt
bool	relativeMovement
const float	minPan
const float	minTilt

---

Detailed Description

the parameters for the class panTiltUnit

---

Member Enumeration Documentation

enum lti::panTiltUnit::parameters::eAngleFormatType

angle formats

---

Constructor & Destructor Documentation

lti::panTiltUnit::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

lti::panTiltUnit::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

lti::panTiltUnit::parameters::parameters	(	float	minPan,
		float	maxPan,
		float	minTilt,
		float	maxTilt
	)

constructor

Parameters:

	minPan
	maxPan
	minTilt
	maxTilt

lti::panTiltUnit::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::panTiltUnit::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

parameters& lti::panTiltUnit::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

const char* lti::panTiltUnit::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

parameters& lti::panTiltUnit::parameters::operator=

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

virtual bool lti::panTiltUnit::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

virtual bool lti::panTiltUnit::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::functor::parameters.

Reimplemented in lti::directedPerceptionPTU::parameters, and lti::sonyEviD100P::parameters.

---

Member Data Documentation

eAngleFormatType lti::panTiltUnit::parameters::angleFormat

Specifies if the pan and tilt values are measured in degrees or radiant.

Default: Radiant.

const float lti::panTiltUnit::parameters::minPan

The pan tilt unit can physically move between minPan and maxPan.

This values are always specified in radiants and automatically converted by the getMinPan() / getMaxPan() method if the angle format is set to degrees.

const float lti::panTiltUnit::parameters::minTilt

The pan tilt unit can physically move between minTilt and maxTilt.

This values are always specified in radiants and automatically converted by the getMinTilt() / getMaxTilt() method if the angle format is set to degrees.

float lti::panTiltUnit::parameters::pan

Pan value to which the pan tilt device shall move.

Default: 0.

bool lti::panTiltUnit::parameters::relativeMovement

Specifies whether the pan tilt device shall move to a relative (true) or absolute Position (false).

This is here to ensure a well defined behavior. If a specific pan tilt device does not support the one or the other, catch it in setParameters(). This way any application can be informed about a relative or absolute movement.

float lti::panTiltUnit::parameters::tilt

Tilt value to which the pan tilt device shall move.

Default: 0.

---

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

• ltiPanTiltUnit.h