Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
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:
Teuchos::ValidatorDependency Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject

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

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

Additional Inherited Members

- Public Types inherited from Teuchos::Dependency
typedef std::set< RCP
< ParameterEntry >, RCPComp
ParameterEntryList
 A list of Dependees. More...
 
typedef std::set< RCP< const
ParameterEntry >, RCPConstComp
ConstParameterEntryList
 A list of dependents. More...
 
- Static Public Member Functions inherited from Teuchos::Dependency
static const std::string & getXMLTagName ()
 Returns the XML tag to use when serializing Dependencies. More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 
Validation Functions

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:

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

Definition at line 1373 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
dependeeThe dependee parameter.
dependentThe dependent parameter.
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.

Definition at line 345 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
dependeeThe dependee parameter.
dependentsThe dependents.
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.

Definition at line 357 of file Teuchos_StandardDependencies.cpp.

Member Function Documentation

void Teuchos::BoolValidatorDependency::evaluate ( )
virtual

Implements Teuchos::ValidatorDependency.

Definition at line 369 of file Teuchos_StandardDependencies.cpp.

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

Gets the true validator.

Definition at line 384 of file Teuchos_StandardDependencies.cpp.

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

Gets the false validator.

Definition at line 390 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 395 of file Teuchos_StandardDependencies.cpp.

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: