Teuchos::BoolLogicCondition Class Reference

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

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::BoolLogicCondition:

Public Member Functions
Constructors/Destructor
	BoolLogicCondition (ConstConditionList &conditions)
	Constructs a BoolLogicCondition. More...
virtual	~BoolLogicCondition ()
	Deconstructor for a BoolLogicCondition. More...
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. More...
Attribute/Query Methods
virtual bool	applyOperator (bool op1, bool op2) const =0
	Applies a Bool Logic operator to two operands and returns the result. More...
const ConstConditionList &	getConditions () const
	Gets a list of all conditions that are a part of this BoolLogicCondition/. More...
Overridden from Condition
virtual bool	isConditionTrue () const
bool	containsAtLeasteOneParameter () const
Dependency::ConstParameterEntryList	getAllParameters () const
Public Member Functions inherited from Teuchos::Condition
	Condition ()
	Constructs a Condition. More...
virtual	~Condition ()
	Destructs a condition. More...
virtual std::string	getTypeAttributeValue () const =0
	Get the value that should be used for the condition type attribute when converting a condition to XML. More...
Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object. More...
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream. More...
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream. More...
virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes). More...
Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label. More...
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject). More...
virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject). More...

Additional Inherited Members
Public Types inherited from Teuchos::Condition
typedef Teuchos::Array < Teuchos::RCP< Condition > >	ConditionList
	Convenience typedef for defining a list of conditions. More...
typedef Teuchos::Array < Teuchos::RCP< const Condition > >	ConstConditionList
Static Public Member Functions inherited from Teuchos::Condition
static const std::string &	getXMLTagName ()
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the verbLevel argument of describe(). More...
Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

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 408 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 31 of file Teuchos_StandardConditions.cpp.

virtual Teuchos::BoolLogicCondition::~BoolLogicCondition ( )

inlinevirtual

Deconstructor for a BoolLogicCondition.

Definition at line 425 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 44 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 463 of file Teuchos_StandardConditions.hpp.

bool Teuchos::BoolLogicCondition::isConditionTrue ( ) const

virtual

Implements Teuchos::Condition.

Definition at line 48 of file Teuchos_StandardConditions.cpp.

bool Teuchos::BoolLogicCondition::containsAtLeasteOneParameter ( ) const

virtual

Implements Teuchos::Condition.

Definition at line 58 of file Teuchos_StandardConditions.cpp.

Dependency::ConstParameterEntryList Teuchos::BoolLogicCondition::getAllParameters ( ) const

virtual

Implements Teuchos::Condition.

Definition at line 72 of file Teuchos_StandardConditions.cpp.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp