Optika Development
Public Member Functions | Protected Attributes
Optika::ParameterCondition Class Reference

#include <Optika_StandardConditions.hpp>

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

List of all members.

Public Member Functions

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

Protected Attributes

std::string parameterName
Teuchos::RCP
< Teuchos::ParameterList > 
parentList
bool whenParamEqualsValue
Teuchos::ParameterEntry * parameter

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.


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.

Member Function Documentation

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.

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.

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.


Member Data Documentation

Teuchos::ParameterEntry* Optika::ParameterCondition::parameter [protected]

A pointer to the actual parameter to be evaluated.

Name of parameter to be evaluated.

Teuchos::RCP<Teuchos::ParameterList> Optika::ParameterCondition::parentList [protected]

Parent List of the parameter to be evaluated.

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


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