Optika Development
Public Types | Public Member Functions
Optika::StringCondition Class Reference

#include <Optika_StandardConditions.hpp>

Inheritance diagram for Optika::StringCondition:
Inheritance graph
[legend]
Collaboration diagram for Optika::StringCondition:
Collaboration 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)
bool isConditionTrue ()

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.


Member Typedef Documentation

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

Convience typedef representing an array of strings.


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.
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.

Member Function Documentation

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

Determins whether or not a condition is true.

Implements Optika::ParameterCondition.


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