00001 /* @HEADER@ */ 00002 // ************************************************************************ 00003 // 00004 // Sundance 00005 // Copyright 2011 Sandia Corporation 00006 // 00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, 00008 // the U.S. Government retains certain rights in this software. 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 Kevin Long (kevin.long@ttu.edu) 00038 // 00039 00040 /* @HEADER@ */ 00041 00042 #ifndef SUNDANCE_EXPRBASE_H 00043 #define SUNDANCE_EXPRBASE_H 00044 00045 00046 #include "SundanceDefs.hpp" 00047 #include "PlayaExceptions.hpp" 00048 #include "SundanceSet.hpp" 00049 #include "Teuchos_XMLObject.hpp" 00050 #include "Teuchos_RefCountPtrDecl.hpp" 00051 #include "PlayaHandleable.hpp" 00052 00053 00054 00055 namespace Sundance 00056 { 00057 using namespace Sundance; 00058 using namespace Teuchos; 00059 00060 00061 00062 00063 00064 /** */ 00065 class ExprBase : public Playa::Handleable<ExprBase> 00066 { 00067 public: 00068 /** empty ctor */ 00069 ExprBase(); 00070 00071 /** virtual destructor */ 00072 virtual ~ExprBase() {;} 00073 00074 /** Write a simple text description suitable 00075 * for output to a terminal */ 00076 virtual std::ostream& toText(std::ostream& os, bool paren) const = 0 ; 00077 00078 /** Append to the set of func IDs present in this expression. 00079 * Base class does nothing */ 00080 virtual void accumulateFuncSet(Set<int>& funcIDs, 00081 const Set<int>& activeSet) const {;} 00082 00083 /** Indicate whether this expression contains any test 00084 * functions. Default is to return false. This will be 00085 * overridden by TestFuncElement and ExprWithChildren. */ 00086 virtual bool hasTestFunctions() const {return false;} 00087 /** 00088 * Indicate whether the expression contains unknown functions */ 00089 virtual bool hasUnkFunctions() const {return false;} 00090 00091 /** */ 00092 std::string toString() const ; 00093 00094 /** Write in XML */ 00095 virtual XMLObject toXML() const = 0 ; 00096 00097 /** Return a descriptive name for the expression subtype */ 00098 virtual std::string typeName() const ; 00099 00100 protected: 00101 }; 00102 00103 00104 00105 } 00106 00107 #endif