Optika::StringValidatorDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::StringValidatorDependency:

Collaboration diagram for Optika::StringValidatorDependency:

List of all members.

Public Types
typedef std::map< std::string, Teuchos::RCP< const Teuchos::ParameterEntryValidator > >	ValueToValidatorMap
Public Member Functions
	StringValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList, ValueToValidatorMap valuesAndValidators, Teuchos::RCP< Teuchos::ParameterEntryValidator > defaultValidator)
	StringValidatorDependency (std::string dependeeName, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > parentList, ValueToValidatorMap valuesAndValidators, Teuchos::RCP< Teuchos::ParameterEntryValidator > defaultValidator)
	StringValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents, ValueToValidatorMap valuesAndValidators, Teuchos::RCP< Teuchos::ParameterEntryValidator > defaultValidator)
void	evaluate ()

---

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 dependent must already have a validator assigned to it.
• All of the validators that may be applied to the dependent must match the type of the validator that is currently on the dependent.

---

Member Typedef Documentation

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

Conveniece typedef

---

Constructor & Destructor Documentation

Optika::StringValidatorDependency::StringValidatorDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	dependentParentList,
		ValueToValidatorMap	valuesAndValidators,
		Teuchos::RCP< Teuchos::ParameterEntryValidator >	defaultValidator
	)

Constructs a StringValidatorDependency.

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependentName	The name of the dependent parameter.
dependentParentList	The ParameterList containing the dependent.
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.

Optika::StringValidatorDependency::StringValidatorDependency	(	std::string	dependeeName,
		std::string	dependentName,
		Teuchos::RCP< Teuchos::ParameterList >	parentList,
		ValueToValidatorMap	valuesAndValidators,
		Teuchos::RCP< Teuchos::ParameterEntryValidator >	defaultValidator
	)

Constructs a StringValidatorDependency.

Parameters:

dependeeName	The name of the dependee parameter.
dependentName	The name of the dependent parameter.
parentList	The ParameterList containing the dependent and the dependee.
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.

Optika::StringValidatorDependency::StringValidatorDependency	(	std::string	dependeeName,
		Teuchos::RCP< Teuchos::ParameterList >	dependeeParentList,
		ParameterParentMap	dependents,
		ValueToValidatorMap	valuesAndValidators,
		Teuchos::RCP< Teuchos::ParameterEntryValidator >	defaultValidator
	)

Constructs a StringValidatorDependency.

Parameters:

dependeeName	The name of the dependee parameter.
dependeeParentList	The ParameterList containing the dependee.
dependents	A map containing dependent Parameters associated with their paraent ParameterLists.
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.

---

Member Function Documentation

void Optika::StringValidatorDependency::evaluate

(

)

[virtual]

Evaluates the dependency and makes any appropriate changes to the dependee based on the dependent.

Implements Optika::ValidatorDependency.

---

The documentation for this class was generated from the following files:

• Optika_StandardDependencies.hpp
• Optika_StandardDependencies.cpp