Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ValidatorXMLConverterDB.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_VALIDATORXMLCONVERTERDB_HPP
00044 #define TEUCHOS_VALIDATORXMLCONVERTERDB_HPP
00045 
00050 #include "Teuchos_ValidatorXMLConverter.hpp"
00051 
00052 
00053 namespace Teuchos {
00054 
00055 class ParameterEntryValidator;
00056 
00059 class TEUCHOS_LIB_DLL_EXPORT ValidatorXMLConverterDB {
00060 public:
00061 
00064   
00071   static void addConverter(RCP<const ParameterEntryValidator> validator,
00072     RCP<ValidatorXMLConverter> converterToAdd);
00073   
00075 
00078   
00085   static RCP<const ValidatorXMLConverter> getConverter(
00086     const ParameterEntryValidator& validator);
00087 
00092   static RCP<const ValidatorXMLConverter> 
00093     getConverter(const XMLObject& xmlObject);
00094 
00108   static XMLObject convertValidator(
00109     RCP<const ParameterEntryValidator> validator,
00110     const ValidatortoIDMap& validatorIDsMap,
00111     bool assignedID=true); 
00112 
00122   static RCP<ParameterEntryValidator> 
00123     convertXML(
00124       const XMLObject& xmlObject,
00125       const IDtoValidatorMap& validatorIDsMap);
00126   
00128 
00131 
00137   static void printKnownConverters(std::ostream& out);
00138   
00140 
00141 private:
00142 
00145   
00147   typedef std::map<std::string, RCP<ValidatorXMLConverter> > ConverterMap;
00148 
00150   typedef std::pair<std::string, RCP<ValidatorXMLConverter> > ConverterPair;
00151 
00153 
00156 
00162   static ConverterMap& getConverterMap();
00163   
00165 
00166 
00167 };
00168 
00169 
00170 } // end namespace Teuchos
00171 
00172 
00173 //
00174 // Helper Macros
00175 //
00176 
00177 // Doing this include so that when people macros like 
00178 // TEUCHOS_ADD_STRINGTOINTEGRALCONVERTER below they don't have to bother
00179 // including it themselves. More likely they might not even know they have
00180 // to.
00181 #include "Teuchos_StandardValidatorXMLConverters.hpp"
00182 
00186 #define TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(INTEGRALTYPE) \
00187   \
00188   Teuchos::ValidatorXMLConverterDB::addConverter( \
00189     Teuchos::DummyObjectGetter< \
00190       Teuchos::StringToIntegralParameterEntryValidator< INTEGRALTYPE > >:: \
00191         getDummyObject(), \
00192     Teuchos::rcp(new Teuchos::StringToIntegralValidatorXMLConverter< INTEGRALTYPE >));
00193     
00194 
00195 
00199 #define TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(T) \
00200   \
00201   Teuchos::ValidatorXMLConverterDB::addConverter( \
00202     Teuchos::DummyObjectGetter< \
00203       Teuchos::EnhancedNumberValidator< T > >:: \
00204         getDummyObject(), \
00205     Teuchos::rcp(new Teuchos::EnhancedNumberValidatorXMLConverter< T >));
00206 
00207 
00211 #define TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(VALIDATORTYPE, ENTRYTYPE) \
00212   \
00213   Teuchos::ValidatorXMLConverterDB::addConverter( \
00214     Teuchos::DummyObjectGetter< \
00215       Teuchos::ArrayValidator< VALIDATORTYPE, ENTRYTYPE > >:: \
00216         getDummyObject(), \
00217     Teuchos::rcp(new Teuchos::ArrayValidatorXMLConverter< VALIDATORTYPE, ENTRYTYPE >)); \
00218   Teuchos::ValidatorXMLConverterDB::addConverter( \
00219     Teuchos::DummyObjectGetter< \
00220       Teuchos::TwoDArrayValidator< VALIDATORTYPE, ENTRYTYPE > >:: \
00221         getDummyObject(), \
00222     Teuchos::rcp(new Teuchos::TwoDArrayValidatorXMLConverter< VALIDATORTYPE, ENTRYTYPE >));
00223 
00224 
00226 #define TEUCHOS_ADD_NUMBERTYPE_VALIDATOR_CONVERTERS(T) \
00227   TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(T); \
00228   TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(T); \
00229   TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::EnhancedNumberValidator< T >, T );
00230 
00234 #define TEUCHOS_ADD_VALIDATOR_CONVERTER(VALIDATOR_TYPE, CONVERTER_TYPE) \
00235   Teuchos::ValidatorXMLConverterDB::addConverter( \
00236       Teuchos::DummyObjectGetter< VALIDATOR_TYPE > \
00237       ::getDummyObject(), \
00238       Teuchos::rcp(new CONVERTER_TYPE ));
00239 
00240 #endif // TEUCHOS_VALIDATORXMLCONVERTERDB_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines