Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::EqualsCondition Class Reference

A Bool Logic Condition that returns the result or perfroming a logical EQUALS on the conditions. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::EqualsCondition:
Teuchos::BoolLogicCondition Teuchos::Condition Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

Constructors/Destructor
 EqualsCondition (ConstConditionList &conditions)
 Constructs an Equals Condition. More...
 
virtual ~EqualsCondition ()
 Deconstructs an Equals Condition. More...
 
Overridden from Condition
std::string getTypeAttributeValue () const
 Get the value that should be used for the condition type attribute when converting a condition to XML. More...
 
Overridden from BoolLogicCondition
bool applyOperator (bool op1, bool op2) const
 
- Public Member Functions inherited from Teuchos::BoolLogicCondition
 BoolLogicCondition (ConstConditionList &conditions)
 Constructs a BoolLogicCondition. More...
 
virtual ~BoolLogicCondition ()
 Deconstructor for a BoolLogicCondition. More...
 
void addCondition (RCP< const Condition > toAdd)
 Adds a Condition to the list of conditions that will be evaluated by this Bool Logic Condition. More...
 
const ConstConditionList & getConditions () const
 Gets a list of all conditions that are a part of this BoolLogicCondition/. More...
 
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...
 
- 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...
 

Detailed Description

A Bool Logic Condition that returns the result or perfroming a logical EQUALS on the conditions.

Please see EqualsConditionConverter for documenation regarding the XML representation of this condition.

Definition at line 680 of file Teuchos_StandardConditions.hpp.

Constructor & Destructor Documentation

Teuchos::EqualsCondition::EqualsCondition ( ConstConditionList conditions)

Constructs an Equals Condition.

Parameters
conditionsThe conditions to be evaluated.

Definition at line 146 of file Teuchos_StandardConditions.cpp.

virtual Teuchos::EqualsCondition::~EqualsCondition ( )
inlinevirtual

Deconstructs an Equals Condition.

Definition at line 697 of file Teuchos_StandardConditions.hpp.

Member Function Documentation

std::string Teuchos::EqualsCondition::getTypeAttributeValue ( ) const
inlinevirtual

Get the value that should be used for the condition type attribute when converting a condition to XML.

Implements Teuchos::Condition.

Definition at line 704 of file Teuchos_StandardConditions.hpp.

bool Teuchos::EqualsCondition::applyOperator ( bool  op1,
bool  op2 
) const
virtual

Implements Teuchos::BoolLogicCondition.

Definition at line 149 of file Teuchos_StandardConditions.cpp.


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