43#ifndef TEUCHOS_STANDARDCONDITION_HPP_
44#define TEUCHOS_STANDARDCONDITION_HPP_
51#include "Teuchos_InvalidConditionException.hpp"
53#include "Teuchos_StandardFunctionObjects.hpp"
111 return evaluateParameter();
186 return "StringCondition";
194 bool evaluateParameter()
const;
219 void checkParameterType();
304 value = func_->runFunction(value);
396 return "BoolCondition";
404 bool evaluateParameter()
const;
506 virtual bool isConditionTrue()
const;
509 bool containsAtLeasteOneParameter()
const;
524 ConstConditionList conditions_;
562 return "OrCondition";
571 bool applyOperator(
bool op1,
bool op2)
const;
633 return "AndCondition";
643 bool applyOperator(
bool op1,
bool op2)
const;
705 return "EqualsCondition";
714 bool applyOperator(
bool op1,
bool op2)
const;
778 return childCondition_;
787 bool isConditionTrue()
const;
790 bool containsAtLeasteOneParameter()
const;
796 return "NotCondition";
An object to determin if a particular set of conditions are occuring.
Templated Parameter List class.
Defines basic traits for the scalar field type.
A Bool Logic Condition that returns the result or perfroming a logical AND on the conditions.
virtual ~AndCondition()
Deconstructs an And Condition.
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
A Bool Condition is a Parameter Condition that evaluates whether or not a Boolean parameter is ture.
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
An abstract parent class for all Bool Logic Conditions.
const ConstConditionList & getConditions() const
Gets a list of all conditions that are a part of this BoolLogicCondition/.
virtual ~BoolLogicCondition()
Deconstructor for a BoolLogicCondition.
virtual bool applyOperator(bool op1, bool op2) const =0
Applies a Bool Logic operator to two operands and returns the result.
A Condition determines whether or not a particular set of conditions are currently occuring.
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Class for retrieving a dummy object of type T.
static RCP< T > getDummyObject()
Retrieves a dummy object of type T.
A Bool Logic Condition that returns the result or perfroming a logical EQUALS on the conditions.
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
virtual ~EqualsCondition()
Deconstructs an Equals Condition.
A Not condition returns the result of performing a logical NOT on a given condition.
RCP< const Condition > getChildCondition() const
Retrieve the child condition.
virtual ~NotCondition()
Deconstructs a Not Condition.
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
A Number Condition is a Parameter Condition that evaluates whether or not a number parameter is great...
bool evaluateParameter() const
NumberCondition(RCP< const ParameterEntry > parameter, RCP< const SimpleFunctionObject< T > > func=null)
Constructs a Number Condition.
RCP< const SimpleFunctionObject< T > > getFunctionObject() const
Gets the funciton this NumberCondition is using. Returns null if the NumberCondition is not using one...
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
A Bool Logic Condition that returns the result or perfroming a logical OR on the conditions.
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
virtual ~OrCondition()
Deconstructs an Or Condition.
An Abstract Base class for all ParameterConditions.
bool containsAtLeasteOneParameter() const
Determines whether or not the evaluation of a parameter occurs somewhere in this condition.
RCP< const ParameterEntry > getParameter() const
Gets a const pointer to the Parameter being evaluated by this ParameterCondition.
virtual bool evaluateParameter() const =0
bool isConditionTrue() const
Determins whether or not a condition is true.
This object is held as the "value" in the Teuchos::ParameterList std::map.
Smart reference counting pointer class for automatic garbage collection.
RCP< const T > getConst() const
Return an RCP<const T> version of *this.
bool is_null() const
Returns true if the underlying pointer is null.
A String Condition is a Parameter Condition that evaluates whether or not a string parameter has take...
std::string getTypeAttributeValue() const
Get the value that should be used for the condition type attribute when converting a condition to XML...
Array< std::string > ValueList
Convience typedef representing an array of strings.
const ValueList & getValueList() const
Returns the value list being used with this StringCondition.
static std::string name()
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
This structure defines some basic traits for a scalar field type.