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

An Abstract Base class for all ParameterConditions. More...

#include <Teuchos_StandardConditions.hpp>

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

List of all members.

Constructors/Destructor

 ParameterCondition (RCP< const ParameterEntry > parameter)
 Constructs a Parameter Condition.
virtual ~ParameterCondition ()

Attribute/Query Methods

virtual bool evaluateParameter () const =0
RCP< const ParameterEntrygetParameter () const
 Gets a const pointer to the Parameter being evaluated by this ParameterCondition.

Overridden from Condition

bool isConditionTrue () const
 Determins whether or not a condition is true.
bool containsAtLeasteOneParameter () const
 Determines whether or not the evaluation of a parameter occurs somewhere in this condition.
Dependency::ConstParameterEntryList getAllParameters () const
 Gets all of the parameters that are evaluated in this condition.

Private Members

RCP< const ParameterEntryparameterEntry_

Detailed Description

An Abstract Base class for all ParameterConditions.

A Parmaeter Condition examines the value of a given parameter and returns a bool based on the condition of that value.

Definition at line 68 of file Teuchos_StandardConditions.hpp.


Constructor & Destructor Documentation

Teuchos::ParameterCondition::ParameterCondition ( RCP< const ParameterEntry parameter)

Constructs a Parameter Condition.

Parameters:
ParameterThe parameter to be evaluated.

Definition at line 48 of file Teuchos_StandardConditions.cpp.

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

Definition at line 82 of file Teuchos_StandardConditions.hpp.


Member Function Documentation

virtual bool Teuchos::ParameterCondition::evaluateParameter ( ) const [pure virtual]

Evaluate the current condition of a parameter and return the result.

Parameters:
Theresult of evaluating the current condition of the parameter.

Implemented in Teuchos::StringCondition, Teuchos::NumberCondition< T >, and Teuchos::BoolCondition.

RCP<const ParameterEntry> Teuchos::ParameterCondition::getParameter ( ) const [inline]

Gets a const pointer to the Parameter being evaluated by this ParameterCondition.

Definition at line 101 of file Teuchos_StandardConditions.hpp.

bool Teuchos::ParameterCondition::isConditionTrue ( ) const [inline, virtual]

Determins whether or not a condition is true.

Attribute/Query Functions

Implements Teuchos::Condition.

Definition at line 110 of file Teuchos_StandardConditions.hpp.

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

Definition at line 114 of file Teuchos_StandardConditions.hpp.

Dependency::ConstParameterEntryList Teuchos::ParameterCondition::getAllParameters ( ) const [virtual]

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

Implements Teuchos::Condition.

Definition at line 58 of file Teuchos_StandardConditions.cpp.


Member Data Documentation

Parameter to be evaluated.

Definition at line 130 of file Teuchos_StandardConditions.hpp.


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