Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos::Condition Class Reference

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

#include <Teuchos_Condition.hpp>

Inheritance diagram for Teuchos::Condition:
Inheritance graph
[legend]

List of all members.

Public types

typedef Teuchos::Array
< Teuchos::RCP< Condition > > 
ConditionList
 Convenience typedef for defining a list of conditions.
typedef Teuchos::Array
< Teuchos::RCP< const
Condition > > 
ConstConditionList

Constructors/Destructor

 Condition ()
 Constructs a Condition.
virtual ~Condition ()
 Destructs a condition.
virtual bool isConditionTrue () const =0
 Determins whether or not a condition is true.
virtual bool containsAtLeasteOneParameter () const =0
 Determines whether or not the evaluation of a parameter occurs somewhere in this condition.
virtual
Dependency::ConstParameterEntryList 
getAllParameters () const =0
 Gets all of the parameters that are evaluated in this condition.
virtual std::string getTypeAttributeValue () const =0
 Get the value that should be used for the condition type attribute when converting a condition to XML.
static const std::string & getXMLTagName ()
 

Detailed Description

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

Definition at line 62 of file Teuchos_Condition.hpp.


Member Typedef Documentation

Convenience typedef for defining a list of conditions.

Definition at line 71 of file Teuchos_Condition.hpp.

Definition at line 73 of file Teuchos_Condition.hpp.


Constructor & Destructor Documentation

Teuchos::Condition::Condition ( ) [inline]

Constructs a Condition.

Definition at line 83 of file Teuchos_Condition.hpp.

virtual Teuchos::Condition::~Condition ( ) [inline, virtual]

Destructs a condition.

Definition at line 88 of file Teuchos_Condition.hpp.


Member Function Documentation

virtual bool Teuchos::Condition::isConditionTrue ( ) const [pure virtual]

Determins whether or not a condition is true.

Attribute/Query Functions

Implemented in Teuchos::ParameterCondition, Teuchos::BoolLogicCondition, and Teuchos::NotCondition.

virtual bool Teuchos::Condition::containsAtLeasteOneParameter ( ) const [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 Teuchos::ParameterCondition, Teuchos::BoolLogicCondition, and Teuchos::NotCondition.

virtual Dependency::ConstParameterEntryList Teuchos::Condition::getAllParameters ( ) const [pure virtual]

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

Implemented in Teuchos::ParameterCondition, Teuchos::BoolLogicCondition, and Teuchos::NotCondition.

virtual std::string Teuchos::Condition::getTypeAttributeValue ( ) const [pure virtual]

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

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

static const std::string& Teuchos::Condition::getXMLTagName ( ) [inline, static]

Definition at line 120 of file Teuchos_Condition.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines