Optika::BinaryLogicalCondition Class Reference

#include <Optika_StandardConditions.hpp>

Inheritance diagram for Optika::BinaryLogicalCondition:
Inheritance graph
[legend]
Collaboration diagram for Optika::BinaryLogicalCondition:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BinaryLogicalCondition (ConditionList &conditions)
virtual ~BinaryLogicalCondition ()
virtual void addCondition (Teuchos::RCP< Condition > toAdd)
virtual bool isConditionTrue ()=0
bool containsAtLeasteOneParameter ()
Dependency::ParameterParentMap getAllParameters ()

Protected Attributes

ConditionList conditions

Detailed Description

An abstract parent class for all Binary Logic Conditions. Binary Logic Conditions return the result of performing some Logical operation on a set of conditions. Note that although the name implies the evaluation of two conditions, Binary Logic Conditions can actually evaluate and arbiturary number of conditions.


Constructor & Destructor Documentation

Optika::BinaryLogicalCondition::BinaryLogicalCondition ( ConditionList conditions  ) 

Constructs a BinaryLogicCondition

Parameters:
conditions The conditions to be evaluated.
virtual Optika::BinaryLogicalCondition::~BinaryLogicalCondition (  )  [inline, virtual]

Deconstructor for a BinaryLogicCondition


Member Function Documentation

void Optika::BinaryLogicalCondition::addCondition ( Teuchos::RCP< Condition toAdd  )  [virtual]

Adds a Condition to the list of conditions that will be evaluated by this Binary Logica Condition.

Parameters:
toAdd The condition to be added to the list of conditions this Binary Logic Condition will evaluate.
bool Optika::BinaryLogicalCondition::containsAtLeasteOneParameter (  )  [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.

Implements Optika::Condition.

Dependency::ParameterParentMap Optika::BinaryLogicalCondition::getAllParameters (  )  [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.

Implements Optika::Condition.

virtual bool Optika::BinaryLogicalCondition::isConditionTrue (  )  [pure virtual]

Determins whether or not a condition is true.

Implements Optika::Condition.

Implemented in Optika::OrCondition, Optika::AndCondition, and Optika::EqualsCondition.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations
Generated on Wed Apr 13 10:05:55 2011 for Optika by  doxygen 1.6.3