Teuchos - Trilinos Tools Package Version of the Day
Teuchos::StringValidatorDependency Class Reference

A StringValidatorDependency 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::StringValidatorDependency:
Teuchos::ValidatorDependency Teuchos::Dependency Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Types

Public types
typedef std::map< std::string,
RCP< const
ParameterEntryValidator > > 
ValueToValidatorMap
 Conveniece typedef.
typedef std::pair< std::string,
RCP< const
ParameterEntryValidator > > 
ValueToValidatorPair
 Conveniece typedef.

Public Member Functions

Constructors/Destructor
 StringValidatorDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, ValueToValidatorMap valuesAndValidators, RCP< ParameterEntryValidator > defaultValidator=null)
 Constructs a StringValidatorDependency.
 StringValidatorDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, ValueToValidatorMap valuesAndValidators, RCP< ParameterEntryValidator > defaultValidator=null)
 Constructs a StringValidatorDependency.
Getters
const ValueToValidatorMapgetValuesAndValidators () const
 retrieve a const reference to the ValueToValidator map being used by this StringValidatorDependency
RCP< const
ParameterEntryValidator
getDefaultValidator () const
 

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.

Detailed Description

A StringValidatorDependency 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:

If the dependee takes on a value not in the valuesAndValidators map, then the default validator is assigned to the dependent.

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

Definition at line 1247 of file Teuchos_StandardDependencies.hpp.


Member Typedef Documentation

Conveniece typedef.

Definition at line 1258 of file Teuchos_StandardDependencies.hpp.

Conveniece typedef.

Definition at line 1264 of file Teuchos_StandardDependencies.hpp.


Constructor & Destructor Documentation

Teuchos::StringValidatorDependency::StringValidatorDependency ( RCP< const ParameterEntry dependee,
RCP< ParameterEntry dependent,
ValueToValidatorMap  valuesAndValidators,
RCP< ParameterEntryValidator defaultValidator = null 
)

Constructs a StringValidatorDependency.

Parameters:
dependeeThe dependee parameter.
dependentThe dependent parameter.
valuesAndValidatorsA map associating string values with ParameterEntryValidators. This will be used to deteremine what type of validator should be applied to the dependent based on the dependees value.
defaultValidatorIf a value is entered in the dependee that is not in the valuesAndValidators map, this is the validator that will be assigned to the dependent.

Definition at line 272 of file Teuchos_StandardDependencies.cpp.

Teuchos::StringValidatorDependency::StringValidatorDependency ( RCP< const ParameterEntry dependee,
Dependency::ParameterEntryList  dependents,
ValueToValidatorMap  valuesAndValidators,
RCP< ParameterEntryValidator defaultValidator = null 
)

Constructs a StringValidatorDependency.

Parameters:
dependeeThe dependee parameter.
dependentsThe dependents.
valuesAndValidatorsA map associating string values with ParameterEntryValidators. This will be used to deteremine what type of validator should be applied to the dependent based on the dependees value.
defaultValidatorIf a value is entered in the dependee that is not in the valuesAndValidators map, this is the validator that will be assigned to the dependent.

Definition at line 284 of file Teuchos_StandardDependencies.cpp.


Member Function Documentation

const StringValidatorDependency::ValueToValidatorMap & Teuchos::StringValidatorDependency::getValuesAndValidators ( ) const

retrieve a const reference to the ValueToValidator map being used by this StringValidatorDependency

Definition at line 297 of file Teuchos_StandardDependencies.cpp.

RCP< const ParameterEntryValidator > Teuchos::StringValidatorDependency::getDefaultValidator ( ) const

Definition at line 303 of file Teuchos_StandardDependencies.cpp.

void Teuchos::StringValidatorDependency::evaluate ( ) [virtual]

Implements Teuchos::ValidatorDependency.

Definition at line 308 of file Teuchos_StandardDependencies.cpp.

std::string Teuchos::StringValidatorDependency::getTypeAttributeValue ( ) const [virtual]

Implements Teuchos::Dependency.

Definition at line 328 of file Teuchos_StandardDependencies.cpp.

void Teuchos::StringValidatorDependency::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 332 of file Teuchos_StandardDependencies.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines