WPropertyVariable< T >::PropertyConstraint Class Reference

Class building the base for user defined constraints on a property instance. More...

#include <WPropertyVariable.h>

Inheritance diagram for WPropertyVariable< T >::PropertyConstraint:

Public Member Functions
	PropertyConstraint ()
	Default constructor. More...
virtual	~PropertyConstraint ()
	Destructor. More...
virtual bool	accept (std::shared_ptr< WPropertyVariable< T > > property, const T &value)=0
	This method decides whether the specified value is valid for a specific property. More...
virtual PROPERTYCONSTRAINT_TYPE	getType ()
	Allows simple identification of the real constraint type. More...
virtual std::shared_ptr< PropertyConstraint >	clone ()=0
	Method to clone the constraint and create a new one with the correct dynamic type. More...

Static Public Member Functions
static std::shared_ptr< PropertyConstraint >	create (PROPERTYCONSTRAINT_TYPE type)
	This method creates a constraint using the specified type. More...

Detailed Description

template<typename T>
class WPropertyVariable< T >::PropertyConstraint

Class building the base for user defined constraints on a property instance.

Definition at line 176 of file WPropertyVariable.h.

Constructor & Destructor Documentation

PropertyConstraint()

template<typename T >

WPropertyVariable< T >::PropertyConstraint::PropertyConstraint

Default constructor.

Definition at line 886 of file WPropertyVariable.h.

~PropertyConstraint()

template<typename T >

WPropertyVariable< T >::PropertyConstraint::~PropertyConstraint

virtual

Destructor.

Definition at line 891 of file WPropertyVariable.h.

Member Function Documentation

accept()

template<typename T >

virtual bool WPropertyVariable< T >::PropertyConstraint::accept ( std::shared_ptr< WPropertyVariable< T > >  property, const T &  value  )

pure virtual

This method decides whether the specified value is valid for a specific property.

Parameters

value	the new value.
property	the property to which the value should be set.

Returns

true whenever the new value is acceptable for the property.

Implemented in WPropertyConstraintSelectOnlyOne< T >, WPropertyConstraintPathExists< T >, WPropertyConstraintNotEmpty< T >, WPropertyConstraintMin< T >, WPropertyConstraintMax< T >, WPropertyConstraintIsValid< T >, WPropertyConstraintIsDirectory< T >, and WPropertyConstraintConfirmOverwrite< T >.

clone()

template<typename T >

virtual std::shared_ptr< PropertyConstraint > WPropertyVariable< T >::PropertyConstraint::clone ( )

pure virtual

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

Returns

the constraint.

Implemented in WMTemplate::StringLength, WMHARDIToSphericalHarmonics::evenInt, WPropertyConstraintSelectOnlyOne< T >, WPropertyConstraintPathExists< T >, WPropertyConstraintNotEmpty< T >, WPropertyConstraintMin< T >, WPropertyConstraintMax< T >, WPropertyConstraintIsValid< T >, WPropertyConstraintIsDirectory< T >, and WPropertyConstraintConfirmOverwrite< T >.

create()

template<typename T >

static std::shared_ptr< PropertyConstraint > WPropertyVariable< T >::PropertyConstraint::create ( PROPERTYCONSTRAINT_TYPE  type )

static

This method creates a constraint using the specified type.

This is a useful convenience class for easily adding constraints.

Parameters

type	the type of the constraint to create

Returns

NULL if the type is unknown or an constraint instance

getType()

template<typename T >

PROPERTYCONSTRAINT_TYPE WPropertyVariable< T >::PropertyConstraint::getType

virtual

Allows simple identification of the real constraint type.

Returns

the type

Reimplemented in WPropertyConstraintSelectOnlyOne< T >, WPropertyConstraintPathExists< T >, WPropertyConstraintNotEmpty< T >, WPropertyConstraintMin< T >, WPropertyConstraintMax< T >, WPropertyConstraintIsValid< T >, WPropertyConstraintIsDirectory< T >, and WPropertyConstraintConfirmOverwrite< T >.

Definition at line 896 of file WPropertyVariable.h.

---

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

• WPropertyVariable.h