WPropertyConstraintMin< T > Class Template Reference

This class allows constraining properties using a minimum value and the corresponding >= operator. More...

#include <WPropertyConstraintMin.h>

Inheritance diagram for WPropertyConstraintMin< T >:

List of all members.

Public Member Functions
	WPropertyConstraintMin (T min)
	Constructor.
virtual	~WPropertyConstraintMin ()
	Destructor.
virtual bool	accept (boost::shared_ptr< WPropertyVariable< T > > property, T value)
	Checks whether the specified new value is larger or equal to the specified min value.
T	getMin ()
	Returns the current min 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_min
	The minimal 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 WPropertyConstraintMin< T >

This class allows constraining properties using a minimum value and the corresponding >= operator.

Definition at line 35 of file WPropertyConstraintMin.h.

---

Constructor & Destructor Documentation

template<typename T >

WPropertyConstraintMin< T >::WPropertyConstraintMin ( T  min )

explicit

Constructor.

Parameters:

min	the minimum value which the new property value should have.

Definition at line 90 of file WPropertyConstraintMin.h.

template<typename T >

WPropertyConstraintMin< T >::~WPropertyConstraintMin ( )

virtual

Destructor.

Definition at line 96 of file WPropertyConstraintMin.h.

---

Member Function Documentation

template<typename T >

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

virtual

Checks whether the specified new value is larger or equal to the specified min value.

Parameters:

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

Returns:

true if value >= m_min

Implements WPropertyVariable< T >::PropertyConstraint.

Definition at line 101 of file WPropertyConstraintMin.h.

template<typename T >

boost::shared_ptr< typename WPropertyVariable< T >::PropertyConstraint > WPropertyConstraintMin< 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 WPropertyConstraintMin.h.

template<typename T >

T WPropertyConstraintMin< T >::getMin

(

)

Returns the current min value.

Returns:

the min value.

Definition at line 107 of file WPropertyConstraintMin.h.

template<typename T >

PROPERTYCONSTRAINT_TYPE WPropertyConstraintMin< 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 WPropertyConstraintMin.h.

---

Member Data Documentation

template<typename T >

T WPropertyConstraintMin< T >::m_min

private

The minimal value the property should have.

Definition at line 86 of file WPropertyConstraintMin.h.

---

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

• WPropertyConstraintMin.h