Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ParameterEntryXMLConverterDB.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_PARAMETERENTRYXMLCONVERTERDB_HPP
00044 #define TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
00045 
00046 #include "Teuchos_StandardParameterEntryXMLConverters.hpp"
00047 #include "Teuchos_XMLParameterListExceptions.hpp"
00048 #include "Teuchos_XMLParameterListWriter.hpp"
00049 
00050 
00056 namespace Teuchos {
00057 
00060 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryXMLConverterDB {
00061 public:
00062 
00065   
00070   static void addConverter(RCP<ParameterEntryXMLConverter> converterToAdd){
00071     getConverterMap().insert(
00072       ConverterPair(converterToAdd->getTypeAttributeValue(), converterToAdd));
00073   }
00074   
00076 
00079 
00080 
00085   static RCP<const ParameterEntryXMLConverter> 
00086     getConverter(RCP<const ParameterEntry> entry);
00087 
00092   static RCP<const ParameterEntryXMLConverter> 
00093     getConverter(const XMLObject& xmlObject);
00094 
00096   static RCP<const ParameterEntryXMLConverter> getDefaultConverter();
00097 
00099 
00100   // 2010/07/30: rabarlt: The above two functions should be moved into
00101   // Teuchos_ParameterEntryXMLConvergerDB.cpp.  These functions don't need to
00102   // be inlined and it will be easier to set breakpoints in the debugger if
00103   // they are in a *.cpp file.
00104 
00107   
00111   static XMLObject convertEntry(
00112     RCP<const ParameterEntry> entry, 
00113     const std::string& name,
00114     const ParameterEntry::ParameterEntryID& id,
00115     const ValidatortoIDMap& validatorIDsMap)
00116   {
00117     return getConverter(entry)->fromParameterEntrytoXML(
00118       entry, name, id, validatorIDsMap);
00119   }
00120 
00124   static ParameterEntry convertXML(const XMLObject& xmlObj)
00125   {
00126     return getConverter(xmlObj)->fromXMLtoParameterEntry(xmlObj);
00127   }
00128   
00130 
00133 
00139   static void printKnownConverters(std::ostream& out);
00141 
00142 private:
00143 
00146 
00148   typedef std::map<std::string, RCP<ParameterEntryXMLConverter> > ConverterMap;
00149 
00151   typedef std::pair<std::string, RCP<ParameterEntryXMLConverter> > ConverterPair;
00152 
00154   
00156   static ConverterMap& getConverterMap();
00157   
00158 
00159 };
00160 
00161 
00162 } // namespace Teuchos
00163 
00164 //
00165 // Helper Macros
00166 //
00167 
00168 
00172 #define TEUCHOS_ADD_TYPE_CONVERTER(T) \
00173   \
00174   Teuchos::ParameterEntryXMLConverterDB::addConverter( \
00175     Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< T >));
00176 
00180 #define TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T) \
00181   Teuchos::ParameterEntryXMLConverterDB::addConverter( \
00182     Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::Array< T > >)); \
00183   Teuchos::ParameterEntryXMLConverterDB::addConverter( \
00184     Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::TwoDArray< T > >));
00185 
00189 #define TEUCHOS_ADD_TYPE_AND_ARRAYTYPE_CONVERTER(T) \
00190   \
00191   TEUCHOS_ADD_TYPE_CONVERTER(T); \
00192   TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T);
00193 
00194 
00195 #endif // TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines