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

#include <Optika_StandardConditions.hpp>

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

List of all members.

Public Types

typedef Teuchos::Array
< std::string > 
ValueList

Public Member Functions

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

Private Attributes

ValueList values

Detailed Description

A String Condition is a Parameter Condition that evaluates whether or not a string parameter has taken on a particular value or set of values.

Definition at line 230 of file Optika_StandardConditions.hpp.


Member Typedef Documentation

Convience typedef representing an array of strings.

Definition at line 235 of file Optika_StandardConditions.hpp.


Constructor & Destructor Documentation

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

Constructs a String Condition.

Parameters:
parameterNameThe name of the parameter to be evaluated.
parentListThe parent Parameter List of the parameter to be evaluated. #param value The value to compare the parameter's value against.
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 160 of file Optika_StandardConditions.cpp.

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

Constructs a String Condition.

Parameters:
parameterNameThe name of the parameter to be evaluated.
parentListThe parent Parameter List of the parameter to be evaluated. #param values The values to compare the parameter's value against.
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 seet to false if the parameter evaluates to false, then the condition will evaluatae to true.

Definition at line 171 of file Optika_StandardConditions.cpp.

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

Definition at line 263 of file Optika_StandardConditions.hpp.


Member Function Documentation

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

Determins whether or not a condition is true.

Implements Optika::ParameterCondition.

Definition at line 182 of file Optika_StandardConditions.cpp.


Member Data Documentation

A list of values against which to evaluate the parameter's value.

Definition at line 271 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