Optika Development
Public Member Functions
Optika::BoolValidatorDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::BoolValidatorDependency:
Inheritance graph
[legend]
Collaboration diagram for Optika::BoolValidatorDependency:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BoolValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, Teuchos::RCP< const Teuchos::ParameterEntryValidator > trueValidator, Teuchos::RCP< const Teuchos::ParameterEntryValidator > falseValidator)
 BoolValidatorDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, Teuchos::RCP< const Teuchos::ParameterEntryValidator > trueValidator, Teuchos::RCP< const Teuchos::ParameterEntryValidator > falseValidator)
 BoolValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, Teuchos::RCP< const Teuchos::ParameterEntryValidator > trueValidator, Teuchos::RCP< const Teuchos::ParameterEntryValidator > falseValidator)
void evaluate ()

Detailed Description

A BoolValidatorDependency says the following about the relationship between two parameters: Dependening on the value of the dependee, the dependent should use a particular validator from a given set of validators.

A StringValidatorDependency must have the following characterisitics:


Constructor & Destructor Documentation

Optika::BoolValidatorDependency::BoolValidatorDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  dependentParentList,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  trueValidator,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  falseValidator 
)

Constructs a BoolValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
trueValidatorThe validator to be used on the dependent if the dependee is set to true.
falseValidatorThe validator to be used on the dependent if the dependee is set to false.
Optika::BoolValidatorDependency::BoolValidatorDependency ( std::string  dependeeName,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList >  parentList,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  trueValidator,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  falseValidator 
)

Constructs a BoolValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
trueValidatorThe validator to be used on the dependent if the dependee is set to true.
falseValidatorThe validator to be used on the dependent if the dependee is set to false.
Optika::BoolValidatorDependency::BoolValidatorDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList >  dependeeParentList,
ParameterParentMap  dependents,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  trueValidator,
Teuchos::RCP< const Teuchos::ParameterEntryValidator >  falseValidator 
)

Constructs a BoolValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
trueValidatorThe validator to be used on the dependent if the dependee is set to true.
falseValidatorThe validator to be used on the dependent if the dependee is set to false.

Member Function Documentation

void Optika::BoolValidatorDependency::evaluate ( ) [virtual]

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

Implements Optika::ValidatorDependency.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations