stromx::runtime::NumericParameter< data_t > Class Template Reference

Description of a numeric parameter More...

#include <NumericParameter.h>

Inheritance diagram for stromx::runtime::NumericParameter< data_t >:

Public Member Functions
	NumericParameter (const unsigned int id, ParameterGroup *const group=0)
	NumericParameter (const unsigned int id, const data_t min, const data_t max)
	NumericParameter (const unsigned int id, const data_t min, const data_t max, const data_t step)
virtual const Data &	max () const
virtual const Data &	min () const
virtual const Data &	step () const
virtual void	setMax (const data_t &value)
virtual void	setMin (const data_t &value)
virtual void	setStep (const data_t &value)
Public Member Functions inherited from stromx::runtime::Parameter
	Parameter (const unsigned int id, const VariantHandle &variant, ParameterGroup *const group=0)
AccessMode	accessMode () const
void	setAccessMode (const AccessMode mode)
UpdateBehavior	updateBehavior () const
void	setUpdateBehavior (const UpdateBehavior behavior)
virtual const Parameter *	group () const
virtual const std::vector< const Parameter * > &	members () const
virtual Type	originalType () const
virtual Type	currentType () const
Public Member Functions inherited from stromx::runtime::Description
	Description (const unsigned int id, const VariantHandle &variant)
const std::string &	title () const
unsigned int	id () const
const VariantHandle &	variant () const
void	setTitle (const std::string &title)
const VariantHandle &	visualization () const
void	setVisualization (const VariantHandle &visualization)
virtual const std::vector< EnumDescription > &	descriptions () const
virtual unsigned int	rows () const
virtual unsigned int	cols () const

Additional Inherited Members
Public Types inherited from stromx::runtime::Parameter
enum	AccessMode {   NO_ACCESS, NONE_READ, NONE_WRITE, INITIALIZED_READ,   INITIALIZED_WRITE, ACTIVATED_WRITE }
Public Types inherited from stromx::runtime::Description
enum	Type { NO_TYPE, PARAMETER, INPUT, OUTPUT }
enum	UpdateBehavior { PERSISTENT, PUSH, PULL, INTERNAL }

Detailed Description

template<typename data_t>
class stromx::runtime::NumericParameter< data_t >

Description of a numeric parameter

Constructor & Destructor Documentation

NumericParameter() [1/3]

template<typename data_t>

stromx::runtime::NumericParameter< data_t >::NumericParameter ( const unsigned int  id, ParameterGroup *const  group = 0  )

inline

Constructs a numeric parameter.

NumericParameter() [2/3]

template<typename data_t>

stromx::runtime::NumericParameter< data_t >::NumericParameter ( const unsigned int  id, const data_t  min, const data_t  max  )

inline

Constructs a numeric parameter.

NumericParameter() [3/3]

template<typename data_t>

stromx::runtime::NumericParameter< data_t >::NumericParameter ( const unsigned int  id, const data_t  min, const data_t  max, const data_t  step  )

inline

Constructs a numeric parameter.

Member Function Documentation

max()

template<typename data_t>

virtual const Data& stromx::runtime::NumericParameter< data_t >::max ( ) const

inlinevirtual

Returns the maximal value of this data value or an instance of None.

Reimplemented from stromx::runtime::Description.

min()

template<typename data_t>

virtual const Data& stromx::runtime::NumericParameter< data_t >::min ( ) const

inlinevirtual

Returns the minimal value of this data value or an instance of None.

Reimplemented from stromx::runtime::Description.

setMax()

template<typename data_t>

virtual void stromx::runtime::NumericParameter< data_t >::setMax ( const data_t &  value )

inlinevirtual

Sets the maximal value of the parameter.

setMin()

template<typename data_t>

virtual void stromx::runtime::NumericParameter< data_t >::setMin ( const data_t &  value )

inlinevirtual

Sets the minimal value of the parameter.

setStep()

template<typename data_t>

virtual void stromx::runtime::NumericParameter< data_t >::setStep ( const data_t &  value )

inlinevirtual

Sets the step value of the parameter.

step()

template<typename data_t>

virtual const Data& stromx::runtime::NumericParameter< data_t >::step ( ) const

inlinevirtual

Returns a useful step size to decrease or increase the value of this parameter. Returns NONE if no step size is defined for this parameter.

Reimplemented from stromx::runtime::Description.

---

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

• stromx/cvsupport/DummyCamera.h
• stromx/runtime/NumericParameter.h