Teuchos::BoolValidatorDependency Class Reference

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. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::BoolValidatorDependency:

List of all members.

Constructors/Destructor
	BoolValidatorDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const ParameterEntryValidator > trueValidator, RCP< const ParameterEntryValidator > falseValidator=null)
	Constructs a BoolValidatorDependency.
	BoolValidatorDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const ParameterEntryValidator > trueValidator, RCP< const ParameterEntryValidator > falseValidator=null)
	Constructs a BoolValidatorDependency.
Overridden from Dependency
void	evaluate ()
std::string	getTypeAttributeValue () const
void	validateDep () const
	Validates the dependency to make sure it's valid/has been setup properly. If subclassing, this fucntion should be called in the new subclasses constructor.
Getters
RCP< const ParameterEntryValidator >	getTrueValidator () const
	Gets the true validator.
RCP< const ParameterEntryValidator >	getFalseValidator () const
	Gets the false validator.
Private Members
RCP< const ParameterEntryValidator >	trueValidator_
	The validators to be used when the dependee is either true or false.
RCP< const ParameterEntryValidator >	falseValidator_

---

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 BoolValidatorDependency must have the following characterisitics:

• The dependee must be of type bool

• The false and true validators must be the same type.

Please see BoolValidatorDependencyXMLConverter for documentation regarding the XML representation of this Dependency.

Definition at line 1407 of file Teuchos_StandardDependencies.hpp.

---

Constructor & Destructor Documentation

Teuchos::BoolValidatorDependency::BoolValidatorDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		RCP< const ParameterEntryValidator >	trueValidator,
		RCP< const ParameterEntryValidator >	falseValidator = null
	)

Constructs a BoolValidatorDependency.

Parameters:

dependee	The dependee parameter.
dependent	The dependent parameter.
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.

Definition at line 379 of file Teuchos_StandardDependencies.cpp.

Teuchos::BoolValidatorDependency::BoolValidatorDependency	(	RCP< const ParameterEntry >	dependee,
		Dependency::ParameterEntryList	dependents,
		RCP< const ParameterEntryValidator >	trueValidator,
		RCP< const ParameterEntryValidator >	falseValidator = null
	)

Constructs a BoolValidatorDependency.

Parameters:

dependee	The dependee parameter.
dependents	The dependents.
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.

Definition at line 391 of file Teuchos_StandardDependencies.cpp.

---

Member Function Documentation

void Teuchos::BoolValidatorDependency::evaluate

(

)

[virtual]

Implements Teuchos::ValidatorDependency.

Definition at line 403 of file Teuchos_StandardDependencies.cpp.

RCP< const ParameterEntryValidator > Teuchos::BoolValidatorDependency::getTrueValidator

(

)

const

Gets the true validator.

Definition at line 418 of file Teuchos_StandardDependencies.cpp.

RCP< const ParameterEntryValidator > Teuchos::BoolValidatorDependency::getFalseValidator

(

)

const

Gets the false validator.

Definition at line 424 of file Teuchos_StandardDependencies.cpp.

std::string Teuchos::BoolValidatorDependency::getTypeAttributeValue

(

)

const [virtual]

Implements Teuchos::Dependency.

Definition at line 429 of file Teuchos_StandardDependencies.cpp.

void Teuchos::BoolValidatorDependency::validateDep

(

)

const [protected, virtual]

Validates the dependency to make sure it's valid/has been setup properly. If subclassing, this fucntion should be called in the new subclasses constructor.

Implements Teuchos::Dependency.

Definition at line 434 of file Teuchos_StandardDependencies.cpp.

---

Member Data Documentation

RCP<const ParameterEntryValidator> Teuchos::BoolValidatorDependency::trueValidator_ [private]

The validators to be used when the dependee is either true or false.

Definition at line 1492 of file Teuchos_StandardDependencies.hpp.

RCP<const ParameterEntryValidator> Teuchos::BoolValidatorDependency::falseValidator_ [private]

Definition at line 1492 of file Teuchos_StandardDependencies.hpp.

---

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

• Teuchos_StandardDependencies.hpp
• Teuchos_StandardDependencies.cpp