WPropertyConstraintMax< T > Class Template Reference

This class allows constraining properties using a maximum value and the corresponding <= operator. More...

#include <WPropertyConstraintMax.h>

Inheritance diagram for WPropertyConstraintMax< T >:

List of all members.

Public Member Functions
	WPropertyConstraintMax (T max)
	Constructor.
virtual	~WPropertyConstraintMax ()
	Destructor.
virtual bool	accept (boost::shared_ptr< WPropertyVariable< T > > property, T value)
	Checks whether the specified new value is smaller or equal to the specified max value.
T	getMax ()
	Returns the current max value.
virtual PROPERTYCONSTRAINT_TYPE	getType ()
	Allows simple identification of the real constraint type.
virtual boost::shared_ptr < typename WPropertyVariable < T >::PropertyConstraint >	clone ()
	Method to clone the constraint and create a new one with the correct dynamic type.
Public Member Functions inherited from WPropertyVariable< T >::PropertyConstraint
	PropertyConstraint ()
	Default constructor.
virtual	~PropertyConstraint ()
	Destructor.

Private Attributes
T	m_max
	The maximal value the property should have.

Additional Inherited Members
Static Public Member Functions inherited from WPropertyVariable< T >::PropertyConstraint
static boost::shared_ptr < PropertyConstraint >	create (PROPERTYCONSTRAINT_TYPE type)
	This method creates a constraint using the specified type.

---

Detailed Description

template<typename T>
class WPropertyConstraintMax< T >

This class allows constraining properties using a maximum value and the corresponding <= operator.

Definition at line 35 of file WPropertyConstraintMax.h.

---

Constructor & Destructor Documentation

template<typename T >

WPropertyConstraintMax< T >::WPropertyConstraintMax ( T  max )

explicit

Constructor.

Parameters:

max	the maximum value which the new property value should have.

Definition at line 90 of file WPropertyConstraintMax.h.

template<typename T >

WPropertyConstraintMax< T >::~WPropertyConstraintMax ( )

virtual

Destructor.

Definition at line 96 of file WPropertyConstraintMax.h.

---

Member Function Documentation

template<typename T >

bool WPropertyConstraintMax< T >::accept ( boost::shared_ptr< WPropertyVariable< T > >  property, T  value  )

virtual

Checks whether the specified new value is smaller or equal to the specified max value.

Parameters:

property	the property whose new value should be set.
value	the new value to check

Returns:

true if value <= m_max

Implements WPropertyVariable< T >::PropertyConstraint.

Definition at line 101 of file WPropertyConstraintMax.h.

template<typename T >

boost::shared_ptr< typename WPropertyVariable< T >::PropertyConstraint > WPropertyConstraintMax< T >::clone ( )

virtual

Method to clone the constraint and create a new one with the correct dynamic type.

Returns:

the constraint.

Implements WPropertyVariable< T >::PropertyConstraint.

Definition at line 119 of file WPropertyConstraintMax.h.

template<typename T >

T WPropertyConstraintMax< T >::getMax

(

)

Returns the current max value.

Returns:

the max value.

Definition at line 107 of file WPropertyConstraintMax.h.

template<typename T >

PROPERTYCONSTRAINT_TYPE WPropertyConstraintMax< T >::getType ( )

virtual

Allows simple identification of the real constraint type.

Returns:

the type

Reimplemented from WPropertyVariable< T >::PropertyConstraint.

Definition at line 113 of file WPropertyConstraintMax.h.

---

Member Data Documentation

template<typename T >

T WPropertyConstraintMax< T >::m_max

private

The maximal value the property should have.

Definition at line 86 of file WPropertyConstraintMax.h.

---

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

• WPropertyConstraintMax.h