Optika::NumberValidatorAspectDependency< S > Class Template Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::NumberValidatorAspectDependency< S >:

Collaboration diagram for Optika::NumberValidatorAspectDependency< S >:

List of all members.

Public Types
enum	ValidatorAspect { Min, Max, Step }
Public Member Functions
	NumberValidatorAspectDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, Teuchos::RCP< Optika::EnhancedNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
	NumberValidatorAspectDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, Teuchos::RCP< Optika::EnhancedNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
	NumberValidatorAspectDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, Teuchos::RCP< Optika::ArrayNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
	NumberValidatorAspectDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, Teuchos::RCP< Optika::ArrayNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
	NumberValidatorAspectDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, Teuchos::RCP< Optika::EnhancedNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
	NumberValidatorAspectDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, Teuchos::RCP< Optika::ArrayNumberValidator< S > > validator, ValidatorAspect aspect, S(*func)(S)=0)
void	evaluate ()

---

Detailed Description

template<class S>
class Optika::NumberValidatorAspectDependency< S >

A NumberValidatorAspectDependency says the following about the relationship between two parameters in a dependent parameter list: depending of the value of the dependee a particular aspect of the dependents validator will have a certain value.

A NumberValidatorAspectDependency must have the following characteristics:

• The dependee must be of a number type and can't be an array.
• The dependent must have an enhancednumberparameter validator or an arrayNumberValidator.
• The validator specified in the constructor must be the same validator being used on the dependent parameter.
• The template type, dependee type, and dependent type must all be the same.
  dependency can have an interesting effect on your program. The class will modifies dependents validator. If that same validator is used more than once, every other parameter that used that validator will also see the change. Make sure that you are aware of this when making your validators.

---

Member Enumeration Documentation

template<class S >

enum Optika::NumberValidatorAspectDependency::ValidatorAspect

An enum specifying the aspect of the validator that should be modified

---

Constructor & Destructor Documentation

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	dependentParentList,
		Teuchos::RCP< Optika::EnhancedNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependentName	The name of the dependent parameter.
dependentParentList	The ParameterList containing the dependent.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	parentList,
		Teuchos::RCP< Optika::EnhancedNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency

Parameters:

dependeeName	The name of the dependee parameter.
dependentName	The name of the dependent parameter.
parentList	The ParameterList containing the dependent and the dependee.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	dependentParentList,
		Teuchos::RCP< Optika::ArrayNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency. Conveniece Constructor for ArrayNumberValidators

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependentName	The name of the dependent parameter.
dependentParentList	The ParameterList containing the dependent.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	parentList,
		Teuchos::RCP< Optika::ArrayNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency. Conveniece Constructor for ArrayNumberValidators

Parameters:

dependeeName	The name of the dependee parameter.
dependentName	The name of the dependent parameter.
parentList	The ParameterList containing the dependent and the dependee.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		ParameterParentMap	dependents,
		Teuchos::RCP< Optika::EnhancedNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependents	A map containing dependent Parameters associated with their paraent ParameterLists.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

template<class S >

Optika::NumberValidatorAspectDependency< S >::NumberValidatorAspectDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		ParameterParentMap	dependents,
		Teuchos::RCP< Optika::ArrayNumberValidator< S > >	validator,
		ValidatorAspect	aspect,
		S(*)(S)	func = 0
	)		[inline]

Constructs a NumberValidatorDependency. Conveniece Constructor for ArrayNumberValidators

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependents	A map containing dependent Parameters associated with their paraent ParameterLists.
validator	The validator whose aspect will change.
aspect	The aspect of the validator that should change.
func	A function specifying how the value of the validators aspect should be calculated from the dependees value.

---

Member Function Documentation

template<class S >

void Optika::NumberValidatorAspectDependency< S >::evaluate

(

)

[inline, virtual]

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implements Optika::Dependency.

---

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

• Optika_StandardDependencies.hpp