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:

[legend]

List of all members.

Public types
typedef std::map< std::string, RCP< const ParameterEntryValidator > >	ValueToValidatorMap
	Conveniece typedef.
typedef std::pair< std::string, RCP< const ParameterEntryValidator > >	ValueToValidatorPair
	Conveniece typedef.
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 ValueToValidatorMap &	getValuesAndValidators () 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.
Private Members
ValueToValidatorMap	valuesAndValidators_
	A map associating particular dependee values with validators that could be placed on the dependent.
RCP< ParameterEntryValidator >	defaultValidator_
	The default validator to be used if a request is made for a value that does not appear in the valuesAndValidators map.

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:

The dependee must be of type string

The validators in the ValueToValidatorMap must all be the same type.

If a default validator is specified, it must be of the same type as the validators found in the ValueToValidatorMap.

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

typedef std::map<std::string, RCP<const ParameterEntryValidator> > Teuchos::StringValidatorDependency::ValueToValidatorMap

Conveniece typedef.

Definition at line 1258 of file Teuchos_StandardDependencies.hpp.

typedef std::pair<std::string, RCP<const ParameterEntryValidator> > Teuchos::StringValidatorDependency::ValueToValidatorPair

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:

dependee	The dependee parameter.
dependent	The dependent parameter.
valuesAndValidators	A 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.
defaultValidator	If 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 280 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:

dependee	The dependee parameter.
dependents	The dependents.
valuesAndValidators	A 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.
defaultValidator	If 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 292 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 305 of file Teuchos_StandardDependencies.cpp.

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

Definition at line 311 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::ValidatorDependency.

Definition at line 316 of file Teuchos_StandardDependencies.cpp.

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

Implements Teuchos::Dependency.

Definition at line 336 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 340 of file Teuchos_StandardDependencies.cpp.