Optika GUI Toolik Version of the Day
Public Member Functions | Private Member Functions
Optika::ValidatorDependency Class Reference

#include <Optika_StandardDependencies.hpp>

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

List of all members.

Public Member Functions

 ValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, std::string dependentName, Teuchos::RCP< Teuchos::ParameterList > dependentParentList)
 ValidatorDependency (std::string dependeeName, Teuchos::RCP< Teuchos::ParameterList > dependeeParentList, ParameterParentMap dependents)
virtual ~ValidatorDependency ()
virtual void evaluate ()=0

Private Member Functions

virtual void validateDep ()=0

Detailed Description

An abstract base class for all validator dependencies.

Definition at line 149 of file Optika_StandardDependencies.hpp.


Constructor & Destructor Documentation

Optika::ValidatorDependency::ValidatorDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
std::string  dependentName,
Teuchos::RCP< Teuchos::ParameterList dependentParentList 
)

Constructs a ValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentNameThe name of the dependent parameter.
dependentParentListThe ParameterList containing the dependent.

Definition at line 62 of file Optika_StandardDependencies.cpp.

Optika::ValidatorDependency::ValidatorDependency ( std::string  dependeeName,
Teuchos::RCP< Teuchos::ParameterList dependeeParentList,
ParameterParentMap  dependents 
)

Constructs a ValidatorDependency.

Parameters:
dependeeNameThe name of the dependee parameter.
dependeeParentListThe ParameterList containing the dependee.
dependentsA map containing dependent Parameters associated with their paraent ParameterLists.

Definition at line 66 of file Optika_StandardDependencies.cpp.

virtual Optika::ValidatorDependency::~ValidatorDependency ( ) [inline, virtual]

Desctructor

Simply declaring the descrutor as virtual.

Definition at line 177 of file Optika_StandardDependencies.hpp.


Member Function Documentation

virtual void Optika::ValidatorDependency::evaluate ( ) [pure virtual]

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

Implements Optika::Dependency.

Implemented in Optika::StringValidatorDependency, Optika::BoolValidatorDependency, and Optika::RangeValidatorDependency< S >.

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

Implemented in Optika::StringValidatorDependency, Optika::BoolValidatorDependency, and Optika::RangeValidatorDependency< S >.


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