A Number Condition is a Parameter Condition that evaluates whether or not a number parameter is greater than 0 (or some other number based on a given function). If the parameter is greater than 0 this is interperted as the condition being "true". Otherwise the condition is interperted as false. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::NumberCondition< T >:

Public Member Functions
Constructors/Destructor
	NumberCondition (RCP< const ParameterEntry > parameter, RCP< const SimpleFunctionObject< T > > func=null)
	Constructs a Number Condition. More...

virtual	~NumberCondition ()

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 ParameterCondition
bool	evaluateParameter () const

Getters/Setters
RCP< const SimpleFunctionObject< T > >	getFunctionObject () const
	Gets the funciton this NumberCondition is using. Returns null if the NumberCondition is not using one. More...

Public Member Functions inherited from Teuchos::ParameterCondition
	ParameterCondition (RCP< const ParameterEntry > parameter)
	Constructs a Parameter Condition. More...

virtual	~ParameterCondition ()

RCP< const ParameterEntry >	getParameter () const
	Gets a const pointer to the Parameter being evaluated by this ParameterCondition. More...

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...

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

template<class T>
class Teuchos::NumberCondition< T >

A Number Condition is a Parameter Condition that evaluates whether or not a number parameter is greater than 0 (or some other number based on a given function). If the parameter is greater than 0 this is interperted as the condition being "true". Otherwise the condition is interperted as false.

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

Definition at line 227 of file Teuchos_StandardConditions.hpp.

Constructor & Destructor Documentation

template<class T >

Teuchos::NumberCondition< T >::NumberCondition	(	RCP< const ParameterEntry >	parameter,
		RCP< const SimpleFunctionObject< T > >	func = `null`
	)

inline

Constructs a Number Condition.

Parameters

parameterName	The name of the parameter to be evaluated.
func	A function to run the value of the parameter through. If the function returns a value greater than 0, this will be interperted as the condition being "true". If the function returns a value of 0 or less, this will be interperted as the condition being false.

Definition at line 244 of file Teuchos_StandardConditions.hpp.