Optika GUI Toolik Version of the Day
Public Member Functions
Optika::BoolCondition Class Reference

#include <Optika_StandardConditions.hpp>

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

List of all members.

Public Member Functions

 BoolCondition (std::string parameterName, Teuchos::RCP< Teuchos::ParameterList > parentList, bool whenParamEqualsValue=true)
virtual ~BoolCondition ()
bool isConditionTrue ()

Detailed Description

A Bool Condition is a Parameter Condition that evaluates whether or not a Boolean parameter is ture.

Definition at line 356 of file Optika_StandardConditions.hpp.


Constructor & Destructor Documentation

Optika::BoolCondition::BoolCondition ( std::string  parameterName,
Teuchos::RCP< Teuchos::ParameterList parentList,
bool  whenParamEqualsValue = true 
)

Constructs a Bool 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 187 of file Optika_StandardConditions.cpp.

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

Definition at line 370 of file Optika_StandardConditions.hpp.


Member Function Documentation

bool Optika::BoolCondition::isConditionTrue ( ) [virtual]

Determins whether or not a condition is true.

Implements Optika::ParameterCondition.

Definition at line 198 of file Optika_StandardConditions.cpp.


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