Teuchos::BoolLogicCondition Class Reference

An abstract parent class for all Bool Logic Conditions. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::BoolLogicCondition:

List of all members.

Public Member Functions
Constructors/Destructor
	BoolLogicCondition (ConstConditionList &conditions)
	Constructs a BoolLogicCondition.
virtual	~BoolLogicCondition ()
	Deconstructor for a BoolLogicCondition.
Modifier Functions
void	addCondition (RCP< const Condition > toAdd)
	Adds a Condition to the list of conditions that will be evaluated by this Bool Logic Condition.
Attribute/Query Methods
virtual bool	applyOperator (bool op1, bool op2) const =0
	Applies a Bool Logic operator to two operands and returns the result.
const ConstConditionList &	getConditions () const
	Gets a list of all conditions that are a part of this BoolLogicCondition/.
Overridden from Condition
virtual bool	isConditionTrue () const
bool	containsAtLeasteOneParameter () const
Dependency::ConstParameterEntryList	getAllParameters () const

---

Detailed Description

An abstract parent class for all Bool Logic Conditions.

Bool Logic Conditions return the result of performing some Logical operation on a set of conditions. The set of conditions may be an aribtrary size as long as it is two or greater.

Definition at line 441 of file Teuchos_StandardConditions.hpp.

---

Constructor & Destructor Documentation

Teuchos::BoolLogicCondition::BoolLogicCondition

(

ConstConditionList &

conditions

)

Constructs a BoolLogicCondition.

Parameters:

conditions

The conditions to be evaluated.

Definition at line 65 of file Teuchos_StandardConditions.cpp.

virtual Teuchos::BoolLogicCondition::~BoolLogicCondition

(

)

[inline, virtual]

Deconstructor for a BoolLogicCondition.

Definition at line 458 of file Teuchos_StandardConditions.hpp.

---

Member Function Documentation

void Teuchos::BoolLogicCondition::addCondition

(

RCP< const Condition >

toAdd

)

Adds a Condition to the list of conditions that will be evaluated by this Bool Logic Condition.

Parameters:

toAdd

The condition to be added to the list of conditions this Bool Logic Condition will evaluate.

Definition at line 78 of file Teuchos_StandardConditions.cpp.

virtual bool Teuchos::BoolLogicCondition::applyOperator	(	bool	op1,
		bool	op2
	)		const [pure virtual]

Applies a Bool Logic operator to two operands and returns the result.

Parameters:

op1	The first operand.
op2	The second operand.

Returns:

The result of applying a binary logical operator to the two operands.

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

const ConstConditionList& Teuchos::BoolLogicCondition::getConditions

(

)

const [inline]

Gets a list of all conditions that are a part of this BoolLogicCondition/.

Definition at line 496 of file Teuchos_StandardConditions.hpp.

bool Teuchos::BoolLogicCondition::isConditionTrue

(

)

const [virtual]

Implements Teuchos::Condition.

Definition at line 82 of file Teuchos_StandardConditions.cpp.

bool Teuchos::BoolLogicCondition::containsAtLeasteOneParameter

(

)

const [virtual]

Implements Teuchos::Condition.

Definition at line 92 of file Teuchos_StandardConditions.cpp.

Dependency::ConstParameterEntryList Teuchos::BoolLogicCondition::getAllParameters

(

)

const [virtual]

Implements Teuchos::Condition.

Definition at line 106 of file Teuchos_StandardConditions.cpp.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp