Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ConditionXMLConverterDB.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_CONDITIONXMLCONVERTERDB_HPP
00044 #define TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
00045 
00050 // Both includes needed for convience macros below 
00051 #include "Teuchos_StandardConditionXMLConverters.hpp"
00052 #include "Teuchos_StandardConditions.hpp"
00053 
00054 
00055 namespace Teuchos {
00056 
00057 class Condition;
00058 
00061 class TEUCHOS_LIB_DLL_EXPORT ConditionXMLConverterDB {
00062 
00063 public:
00064 
00067   
00074   static void addConverter(RCP<const Condition> condition,
00075     RCP<ConditionXMLConverter> converterToAdd);
00076   
00078 
00081   
00090   static RCP<const ConditionXMLConverter> 
00091     getConverter(const Condition& condition);
00092 
00099   static RCP<const ConditionXMLConverter> 
00100     getConverter(const XMLObject& xmlObject);
00101 
00112   static XMLObject convertCondition(
00113     RCP<const Condition> condition,
00114     const XMLParameterListWriter::EntryIDsMap& entryIDsMap);
00115 
00126   static RCP<Condition> convertXML(
00127     const XMLObject& xmlObject,
00128     const XMLParameterListReader::EntryIDsMap& entryIDsMap);
00129   
00131 
00134 
00140   static void printKnownConverters(std::ostream& out){
00141     out << "Known ConditionXMLConverters: " << std::endl;
00142     for(
00143       ConverterMap::const_iterator it = getConverterMap().begin();
00144       it != getConverterMap().end();
00145       ++it)
00146     {
00147       out << "\t" << it->first <<std::endl;
00148     }
00149   }
00150   
00152 
00153 private:
00154 
00157   
00159   typedef std::map<std::string, RCP<ConditionXMLConverter> > ConverterMap;
00160 
00162   typedef std::pair<std::string, RCP<ConditionXMLConverter> > ConverterPair;
00163 
00167   static ConverterMap& getConverterMap();
00168   
00170 
00171 };
00172 
00173 
00174 } // end namespace Teuchos
00175 
00176 //
00177 // Helper Macros
00178 //
00179 
00181 #define TEUCHOS_ADD_NUMBERCONDITION_CONVERTER(T) \
00182   Teuchos::ConditionXMLConverterDB::addConverter( \
00183     Teuchos::DummyObjectGetter<Teuchos::NumberCondition< T > >:: \
00184       getDummyObject(), \
00185     Teuchos::rcp(new Teuchos::NumberConditionConverter< T >));
00186 
00187 #endif // TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines