Optika::Condition Class Reference

#include <Optika_Condition.hpp>

Inheritance diagram for Optika::Condition:

List of all members.

Public Types
enum	Type { BinLogicCon, NotCon, ParamCon }
typedef Teuchos::Array < Teuchos::RCP< Condition > >	ConditionList
Public Member Functions
	Condition (Type type)
virtual	~Condition ()
virtual bool	isConditionTrue ()=0
virtual bool	containsAtLeasteOneParameter ()=0
virtual Dependency::ParameterParentMap	getAllParameters ()=0
Type	getType ()

---

Detailed Description

A Condition determines whether or not a particular set of conditions are currently occuring.

---

Member Typedef Documentation

typedef Teuchos::Array<Teuchos::RCP<Condition> > Optika::Condition::ConditionList

Conviencne typedef for defining a list of conditions.

---

Member Enumeration Documentation

enum Optika::Condition::Type

Enum to determine the conditoin type.

---

Constructor & Destructor Documentation

Optika::Condition::Condition

(

Type

type

)

[inline]

Construcst a Condition

virtual Optika::Condition::~Condition

(

)

[inline, virtual]

Deconstructs a condition.

---

Member Function Documentation

virtual bool Optika::Condition::containsAtLeasteOneParameter

(

)

[pure virtual]

Determines whether or not the evaluation of a parameter occurs somewhere in this condition.

Returns:

Whether or not the evaluation of a parameter occurs somewhere in this condition.

Implemented in Optika::BinaryLogicalCondition, Optika::NotCondition, and Optika::ParameterCondition.

virtual Dependency::ParameterParentMap Optika::Condition::getAllParameters

(

)

[pure virtual]

Gets all of the parameters that are evaluated in this condition.

Returns:

A map of all of the parameters that are evaluated in this condition.

Implemented in Optika::BinaryLogicalCondition, Optika::NotCondition, and Optika::ParameterCondition.

Type Optika::Condition::getType

(

)

[inline]

Gets the type of the condition.

Returns:

The type of the condition.

virtual bool Optika::Condition::isConditionTrue

(

)

[pure virtual]

Determins whether or not a condition is true.

Implemented in Optika::BinaryLogicalCondition, Optika::OrCondition, Optika::AndCondition, Optika::EqualsCondition, Optika::NotCondition, Optika::ParameterCondition, Optika::StringCondition, Optika::NumberCondition< T >, and Optika::BoolCondition.

---

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

• Optika_Condition.hpp