Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_Condition.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 
00044 #ifndef TEUCHOS_CONDITION_HPP_
00045 #define TEUCHOS_CONDITION_HPP_
00046 
00052 #include "Teuchos_Dependency.hpp"
00053 #include "Teuchos_Describable.hpp"
00054 
00055 namespace Teuchos {
00056 
00062 class TEUCHOS_LIB_DLL_EXPORT Condition : public Describable{
00063 public:
00064 
00067   
00071   typedef Teuchos::Array<Teuchos::RCP<Condition> > ConditionList;
00072 
00073   typedef Teuchos::Array<Teuchos::RCP<const Condition> > ConstConditionList;
00074 
00076 
00079   
00083   Condition(){}
00084 
00088   virtual ~Condition(){}
00089 
00091 
00092 
00095   
00097   virtual bool isConditionTrue() const = 0;
00098 
00106   virtual bool containsAtLeasteOneParameter() const = 0;
00107 
00112   virtual Dependency::ConstParameterEntryList getAllParameters() const = 0;
00113 
00117   virtual std::string getTypeAttributeValue() const = 0;
00118 
00120   static const std::string& getXMLTagName(){
00121     static const std::string xmlTagName = "Condition";
00122     return xmlTagName;
00123   }
00124 
00126   
00127 };
00128 
00129 }
00130 #endif //TEUCHOS_CONDITION_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines