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:

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

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 ValueToValidatorMap &	getValuesAndValidators () const
	retrieve a const reference to the ValueToValidator map being used by this StringValidatorDependency

RCP< const ParameterEntryValidator >	getDefaultValidator () const

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
Static Public Member Functions inherited from Teuchos::Dependency
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().

Validation Functions
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 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 1213 of file Teuchos_StandardDependencies.hpp.

Member Typedef Documentation

◆ ValueToValidatorMap

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

Conveniece typedef.

Definition at line 1224 of file Teuchos_StandardDependencies.hpp.

◆ ValueToValidatorPair

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

Conveniece typedef.

Definition at line 1230 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

◆ StringValidatorDependency() [1/2]

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

◆ StringValidatorDependency() [2/2]

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

Member Function Documentation

◆ getValuesAndValidators()

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

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

Definition at line 268 of file Teuchos_StandardDependencies.cpp.

◆ getDefaultValidator()

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

Definition at line 274 of file Teuchos_StandardDependencies.cpp.

◆ evaluate()

void Teuchos::StringValidatorDependency::evaluate ( )

virtual

Implements Teuchos::ValidatorDependency.

Definition at line 279 of file Teuchos_StandardDependencies.cpp.

◆ getTypeAttributeValue()

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

virtual

Implements Teuchos::Dependency.

Definition at line 299 of file Teuchos_StandardDependencies.cpp.

◆ validateDep()

void Teuchos::StringValidatorDependency::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.