Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_Condition.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42
43
44#ifndef TEUCHOS_CONDITION_HPP_
45#define TEUCHOS_CONDITION_HPP_
46
52#include "Teuchos_Dependency.hpp"
53#include "Teuchos_Describable.hpp"
54
55namespace Teuchos {
56
62class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT Condition : public Describable{
63public:
64
67
72
74
76
79
84
88 virtual ~Condition(){}
89
91
92
95
97 virtual bool isConditionTrue() const = 0;
98
106 virtual bool containsAtLeasteOneParameter() const = 0;
107
113
117 virtual std::string getTypeAttributeValue() const = 0;
118
120 static const std::string& getXMLTagName(){
121 static const std::string xmlTagName = "Condition";
122 return xmlTagName;
123 }
124
126
127};
128
129}
130#endif //TEUCHOS_CONDITION_HPP_
Replacement for std::vector that is compatible with the Teuchos Memory Management classes.
A Condition determines whether or not a particular set of conditions are currently occuring.
Condition()
Constructs a Condition.
virtual ~Condition()
Destructs a condition.
virtual Dependency::ConstParameterEntryList getAllParameters() const =0
Gets all of the parameters that are evaluated in this condition.
virtual bool containsAtLeasteOneParameter() const =0
Determines whether or not the evaluation of a parameter occurs somewhere in this condition.
virtual bool isConditionTrue() const =0
Determins whether or not a condition is true.
Teuchos::Array< Teuchos::RCP< Condition > > ConditionList
Convenience typedef for defining a list of conditions.
static const std::string & getXMLTagName()
virtual std::string getTypeAttributeValue() const =0
Get the value that should be used for the condition type attribute when converting a condition to XML...
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Base class for all objects that can describe themselves.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...