Teuchos::ParameterCondition Class Reference

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

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::ParameterCondition:

List of all members.

Public Member Functions
Constructors/Destructor
	ParameterCondition (RCP< const ParameterEntry > parameter)
	Constructs a Parameter Condition.
virtual	~ParameterCondition ()
Attribute/Query Methods
virtual bool	evaluateParameter () const =0
RCP< const ParameterEntry >	getParameter () 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.

---

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:

Parameter

The parameter to be evaluated.

Definition at line 48 of file Teuchos_StandardConditions.cpp.

---

Member Function Documentation

virtual bool Teuchos::ParameterCondition::evaluateParameter

(

)

const [pure virtual]

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

Parameters:

The	result of evaluating the current condition of the parameter.

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

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.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp