Optika GUI Toolik Version of the Day
Public Member Functions | Protected Attributes
Optika::ParameterCondition Class Reference

#include <Optika_StandardConditions.hpp>

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

List of all members.

Public Member Functions

 ParameterCondition (std::string parameterName, Teuchos::RCP< Teuchos::ParameterList > parentList, bool whenParamEqualsValue)
virtual ~ParameterCondition ()
virtual bool isConditionTrue ()=0
bool containsAtLeasteOneParameter ()
Dependency::ParameterParentMap getAllParameters ()

Protected Attributes

std::string parameterName
Teuchos::RCP
< Teuchos::ParameterList
parentList
bool whenParamEqualsValue
Teuchos::ParameterEntryparameter

Detailed Description

An Abstract Base class for all ParameterConditions. A Parmaeter Condition examines the value of a given parameter and returns a bool based on the condition of that value.

Definition at line 180 of file Optika_StandardConditions.hpp.


Constructor & Destructor Documentation

Optika::ParameterCondition::ParameterCondition ( std::string  parameterName,
Teuchos::RCP< Teuchos::ParameterList parentList,
bool  whenParamEqualsValue 
)

Constructs a Parameter Condition.

Parameters:
parameterNameThe name of the parameter to be evaluated.
parentListThe parent Parameter List of the parameter to be evaluated.
whenParamEqualsValueIndicates whether the condition should be true when the evaluation results in a true or when the evaluation results in a false. When set to true, if the parameter evaluates to true then the condition will evaluate to true. If set to false if the parameter evaluates to false, then the condition will evaluatae to true.

Definition at line 32 of file Optika_StandardConditions.cpp.

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

Definition at line 195 of file Optika_StandardConditions.hpp.


Member Function Documentation

virtual bool Optika::ParameterCondition::isConditionTrue ( ) [pure virtual]

Determins whether or not a condition is true.

Implements Optika::Condition.

Implemented in Optika::StringCondition, Optika::NumberCondition< T >, and Optika::BoolCondition.

bool Optika::ParameterCondition::containsAtLeasteOneParameter ( ) [virtual]

Determines whether or not the evaluation of a parameter occurs somewhere in this condition.

Returns:
Whether or not the evaluation of a parameter occurs somewhere in this condition.

Implements Optika::Condition.

Definition at line 49 of file Optika_StandardConditions.cpp.

Dependency::ParameterParentMap Optika::ParameterCondition::getAllParameters ( ) [virtual]

Gets all of the parameters that are evaluated in this condition.

Returns:
A map of all of the parameters that are evaluated in this condition.

Implements Optika::Condition.

Definition at line 53 of file Optika_StandardConditions.cpp.


Member Data Documentation

Name of parameter to be evaluated.

Definition at line 207 of file Optika_StandardConditions.hpp.

Parent List of the parameter to be evaluated.

Definition at line 212 of file Optika_StandardConditions.hpp.

Wether or not the condition should evaluate to true if the parameter evaluated to true.

Definition at line 217 of file Optika_StandardConditions.hpp.

A pointer to the actual parameter to be evaluated.

Definition at line 222 of file Optika_StandardConditions.hpp.


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