Teuchos - Trilinos Tools Package Version of the Day
|
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>
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 | |
![]() | |
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 const EVerbosityLevel | verbLevel_default = VERB_DEFAULT |
Default value for the verbLevel argument of describe(). | |
Validation Functions | |
![]() | |
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. | |
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 1407 of file Teuchos_StandardDependencies.hpp.
Teuchos::BoolValidatorDependency::BoolValidatorDependency | ( | RCP< const ParameterEntry > | dependee, |
RCP< ParameterEntry > | dependent, | ||
RCP< const ParameterEntryValidator > | trueValidator, | ||
RCP< const ParameterEntryValidator > | falseValidator = null ) |
Constructs a BoolValidatorDependency.
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.
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.
|
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.
|
virtual |
Implements Teuchos::Dependency.
Definition at line 429 of file Teuchos_StandardDependencies.cpp.
|
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 434 of file Teuchos_StandardDependencies.cpp.