Optika GUI Toolik Version of the Day
Public Types | Public Member Functions | Private Member Functions | Private Attributes
Optika::StringValidatorDependency Class Reference

#include <Optika_StandardDependencies.hpp>

Inheritance diagram for Optika::StringValidatorDependency:
Inheritance graph
[legend]

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 ()

Private Member Functions

void validateDep ()

Private Attributes

Teuchos::RCP
< Teuchos::ParameterEntryValidator
defaultValidator
ValueToValidatorMap valuesAndValidators

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:

Definition at line 888 of file Optika_StandardDependencies.hpp.


Member Typedef Documentation

Conveniece typedef

Definition at line 893 of file Optika_StandardDependencies.hpp.


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:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.
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 367 of file Optika_StandardDependencies.cpp.

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:
dependeeNameThe name of the dependee parameter.
dependentNameThe name of the dependent parameter.
parentListThe ParameterList containing the dependent and the dependee.
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 374 of file Optika_StandardDependencies.cpp.

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

Constructs a StringValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.
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 381 of file Optika_StandardDependencies.cpp.


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.

Definition at line 388 of file Optika_StandardDependencies.cpp.

void Optika::StringValidatorDependency::validateDep ( ) [private, 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 Optika::ValidatorDependency.

Definition at line 401 of file Optika_StandardDependencies.cpp.


Member Data Documentation

The default validator to be used if a request is made for a value that does not appear in the valuesAndValidators map.

Definition at line 949 of file Optika_StandardDependencies.hpp.

A map associating particular dependee values with validators that could be placed on the dependent.

Definition at line 955 of file Optika_StandardDependencies.hpp.


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