#include <Optika_StandardConditions.hpp>

Inheritance diagram for Optika::StringCondition:

Collaboration diagram for Optika::StringCondition:

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.

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

Constructs a String Condition.

Parameters:

parameterName	The name of the parameter to be evaluated.
parentList	The parent Parameter List of the parameter to be evaluated. #param value The value to compare the parameter's value against.
whenParamEqualsValue	Indicates 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:

parameterName	The name of the parameter to be evaluated.
parentList	The parent Parameter List of the parameter to be evaluated. #param values The values to compare the parameter's value against.
whenParamEqualsValue	Indicates 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.

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

Determins whether or not a condition is true.

The documentation for this class was generated from the following files: