Optika::BoolCondition Class Reference

#include <Optika_StandardConditions.hpp>

Inheritance diagram for Optika::BoolCondition:

Collaboration diagram for Optika::BoolCondition:

List of all members.

Public Member Functions
	BoolCondition (std::string parameterName, Teuchos::RCP< Teuchos::ParameterList > parentList, bool whenParamEqualsValue=true)
bool	isConditionTrue ()

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

Constructs a Bool Condition.

Parameters:

parameterName	The name of the parameter to be evaluated.
parentList	The parent Parameter List of the parameter to be evaluated.
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.

---

Member Function Documentation

bool Optika::BoolCondition::isConditionTrue

(

)

[virtual]

Determins whether or not a condition is true.

Implements Optika::ParameterCondition.

---

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

• Optika_StandardConditions.hpp
• Optika_StandardConditions.cpp