Teuchos - Trilinos Tools Package Version of the Day
Teuchos_FunctionObjectXMLConverterDB.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 #ifndef TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
00044 #define TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
00045 
00050 // All includes needed for convience macros below 
00051 #include "Teuchos_StandardFunctionObjectXMLConverters.hpp"
00052 #include "Teuchos_StandardFunctionObjects.hpp"
00053 #include "Teuchos_DummyObjectGetter.hpp"
00054 
00055 
00056 namespace Teuchos {
00057 
00061 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT FunctionObjectXMLConverterDB {
00062 
00063 public:
00064 
00067   
00074   static void addConverter(
00075     RCP<const FunctionObject> function,
00076     RCP<FunctionObjectXMLConverter> converterToAdd);
00077   
00079 
00082   
00091   static RCP<const FunctionObjectXMLConverter> 
00092     getConverter(const FunctionObject& function);
00093 
00100   static RCP<const FunctionObjectXMLConverter> 
00101     getConverter(const XMLObject& xmlObject);
00102 
00110   static XMLObject convertFunctionObject(RCP<const FunctionObject> function);
00111 
00120   static RCP<FunctionObject> convertXML(const XMLObject& xmlObject); 
00122 
00125 
00131   static void printKnownConverters(std::ostream& out){
00132     out << "Known ConditionXMLConverters: " << std::endl;
00133     for(
00134       ConverterMap::const_iterator it = getConverterMap().begin();
00135       it != getConverterMap().end();
00136       ++it)
00137     {
00138       out << "\t" << it->first <<std::endl;
00139     }
00140   }
00141   
00143 
00144 private:
00145 
00148   
00150   typedef std::map<std::string, RCP<FunctionObjectXMLConverter> > ConverterMap;
00151 
00153   typedef std::pair<std::string, RCP<FunctionObjectXMLConverter> > ConverterPair;
00154 
00158   static ConverterMap& getConverterMap();
00159   
00161 
00162 };
00163 
00164 
00165 } // end namespace Teuchos
00166 
00167 //
00168 // Helper Macros
00169 //
00170 
00174 #define TEUCHOS_ADD_SIMPLEFUNCTIONCONVERTERS(T) \
00175   Teuchos::FunctionObjectXMLConverterDB::addConverter( \
00176     Teuchos::rcp(new Teuchos::SubtractionFunction< T >), \
00177     Teuchos::DummyObjectGetter<Teuchos::SubtractionFunctionXMLConverter< T > >:: \
00178       getDummyObject()); \
00179       \
00180   Teuchos::FunctionObjectXMLConverterDB::addConverter( \
00181     Teuchos::rcp(new Teuchos::AdditionFunction< T >), \
00182     Teuchos::DummyObjectGetter<Teuchos::AdditionFunctionXMLConverter< T > >:: \
00183       getDummyObject()); \
00184       \
00185   Teuchos::FunctionObjectXMLConverterDB::addConverter( \
00186     Teuchos::rcp(new Teuchos::MultiplicationFunction< T >), \
00187     Teuchos::DummyObjectGetter<Teuchos::MultiplicationFunctionXMLConverter< T > >:: \
00188       getDummyObject()); \
00189       \
00190   Teuchos::FunctionObjectXMLConverterDB::addConverter( \
00191     Teuchos::rcp(new Teuchos::DivisionFunction< T >), \
00192     Teuchos::DummyObjectGetter<Teuchos::DivisionFunctionXMLConverter< T > >:: \
00193       getDummyObject()); \
00194       \
00195 
00196 #endif // TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines