Optika::BoolValidatorDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::BoolValidatorDependency:

Collaboration diagram for Optika::BoolValidatorDependency:

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:

• The dependee must be of type bool
• The dependent must already have a validator assigned to it.
• The "true" and "false" validators that may be applied to the dependent must match the type of the validator that is currently on the dependent.

---

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:

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.
trueValidator	The validator to be used on the dependent if the dependee is set to true.
falseValidator	The 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:

dependeeName	The name of the dependee parameter.
dependentName	The name of the dependent parameter.
parentList	The ParameterList containing the dependent and the dependee.
trueValidator	The validator to be used on the dependent if the dependee is set to true.
falseValidator	The 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:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependents	A map containing dependent Parameters associated with their paraent ParameterLists.
trueValidator	The validator to be used on the dependent if the dependee is set to true.
falseValidator	The 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:

• Optika_StandardDependencies.hpp
• Optika_StandardDependencies.cpp