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:

Public Member Functions
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.
Getters
RCP< const ParameterEntryValidator >	getTrueValidator () const
	Gets the true validator.
RCP< const ParameterEntryValidator >	getFalseValidator () const
	Gets the false validator.
Public Member Functions inherited from Teuchos::ValidatorDependency
	ValidatorDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
	Constructs a ValidatorDependency.
	ValidatorDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
	Constructs a ValidatorDependency.
Public Member Functions inherited from Teuchos::Dependency
	Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
	Constructs a Dependency.
	Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent)
	Constructs a Dependency.
	Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
	Constructs a Dependency.
	Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
	Constructs a Dependency.
virtual void	print (std::ostream &out) const
	prints out information about the dependency.
const ConstParameterEntryList &	getDependees () const
	Gets the dependees of the dependency.
ParameterEntryList &	getDependents ()
	Gets the dependents of the dependency.
const ConstParameterEntryList &	getDependents () const
	Gets the dependents of the dependency.
RCP< const ParameterEntry >	getFirstDependee () const
	Gets the first dependee in the dependees list. This is a convience function.
template<class S>
S	getFirstDependeeValue () const
	Convienence function. Returns the first dependee in the list of dependees.
Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object.
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream.
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream.
virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes).
Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label.
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject).
virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject).

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.

Additional Inherited Members
Public Types inherited from Teuchos::Dependency
typedef std::set< RCP< ParameterEntry >, RCPComp >	ParameterEntryList
	A list of Dependees.
typedef std::set< RCP< const ParameterEntry >, RCPConstComp >	ConstParameterEntryList
	A list of dependents.
static const std::string &	getXMLTagName ()
	Returns the XML tag to use when serializing Dependencies.
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe().
Protected Member Functions inherited from Teuchos::Dependency
Related Symbols inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator.
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator.

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 1373 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

◆ BoolValidatorDependency() [1/2]

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 345 of file Teuchos_StandardDependencies.cpp.

◆ BoolValidatorDependency() [2/2]

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 357 of file Teuchos_StandardDependencies.cpp.

Member Function Documentation

◆ evaluate()

void Teuchos::BoolValidatorDependency::evaluate ( )

virtual

Implements Teuchos::ValidatorDependency.

Definition at line 369 of file Teuchos_StandardDependencies.cpp.

◆ getTrueValidator()

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

Gets the true validator.

Definition at line 384 of file Teuchos_StandardDependencies.cpp.

◆ getFalseValidator()

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

Gets the false validator.

Definition at line 390 of file Teuchos_StandardDependencies.cpp.

◆ getTypeAttributeValue()

std::string Teuchos::BoolValidatorDependency::getTypeAttributeValue ( ) const

virtual

Implements Teuchos::Dependency.

Definition at line 395 of file Teuchos_StandardDependencies.cpp.

◆ validateDep()

void Teuchos::BoolValidatorDependency::validateDep ( ) const

protectedvirtual

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 400 of file Teuchos_StandardDependencies.cpp.

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

Public Member Functions

Overridden from Dependency

Additional Inherited Members