Optika Development
Public Types | Public Member Functions
Optika::NumberValidatorAspectDependency< S > Class Template Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::NumberValidatorAspectDependency< S >:
Inheritance graph
[legend]
Collaboration diagram for Optika::NumberValidatorAspectDependency< S >:
Collaboration graph
[legend]

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:


Member Enumeration Documentation

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:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
validatorThe validator whose aspect will change.
aspectThe aspect of the validator that should change.
funcA 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:
 All Classes Functions Variables Typedefs Enumerations