Teuchos::ParameterCondition Class Reference

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

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::ParameterCondition:

Public Member Functions
Constructors/Destructor
	ParameterCondition (RCP< const ParameterEntry > parameter)
	Constructs a Parameter Condition. More...
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. More...
Overridden from Condition
bool	isConditionTrue () const
	Determins whether or not a condition is true. More...
bool	containsAtLeasteOneParameter () const
	Determines whether or not the evaluation of a parameter occurs somewhere in this condition. More...
Dependency::ConstParameterEntryList	getAllParameters () const
	Gets all of the parameters that are evaluated in this condition. More...
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 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 35 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 14 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 68 of file Teuchos_StandardConditions.hpp.

bool Teuchos::ParameterCondition::isConditionTrue ( ) const

inlinevirtual

Determins whether or not a condition is true.

Attribute/Query Functions

Implements Teuchos::Condition.

Definition at line 77 of file Teuchos_StandardConditions.hpp.

bool Teuchos::ParameterCondition::containsAtLeasteOneParameter ( ) const

inlinevirtual

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 81 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 24 of file Teuchos_StandardConditions.cpp.

---

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

• Teuchos_StandardConditions.hpp
• Teuchos_StandardConditions.cpp