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 oncidiont is interperted as false. More...

#include <Teuchos_StandardConditions.hpp>

Inheritance diagram for Teuchos::NumberCondition< T >:

[legend]

List of all members.

Constructors/Destructor
	NumberCondition (RCP< const ParameterEntry > parameter, RCP< const SimpleFunctionObject< T > > func=null)
	Constructs a Number Condition.
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.
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.
Private Members
RCP< const SimpleFunctionObject< T > >	func_

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 oncidiont is interperted as false.

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

Definition at line 260 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 277 of file Teuchos_StandardConditions.hpp.

template<class T >

virtual Teuchos::NumberCondition< T >::~NumberCondition ( ) [inline, virtual]

Definition at line 284 of file Teuchos_StandardConditions.hpp.