Teuchos - Trilinos Tools Package Version of the Day
Teuchos::NumberCondition< T > Class Template Reference

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 >:
Teuchos::ParameterCondition Teuchos::Condition Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

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.

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:
parameterNameThe name of the parameter to be evaluated.
funcA 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.


Member Function Documentation

template<class T >
std::string Teuchos::NumberCondition< T >::getTypeAttributeValue ( ) const [inline, virtual]

Get the value that should be used for the condition type attribute when converting a condition to XML.

Implements Teuchos::Condition.

Definition at line 291 of file Teuchos_StandardConditions.hpp.

template<class T >
bool Teuchos::NumberCondition< T >::evaluateParameter ( ) const [inline, virtual]

Implements Teuchos::ParameterCondition.

Definition at line 301 of file Teuchos_StandardConditions.hpp.

template<class T >
RCP<const SimpleFunctionObject<T> > Teuchos::NumberCondition< T >::getFunctionObject ( ) const [inline]

Gets the funciton this NumberCondition is using. Returns null if the NumberCondition is not using one.

Definition at line 317 of file Teuchos_StandardConditions.hpp.


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