Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_XMLParameterListReader.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 #ifndef Teuchos_XMLPARAMETERLISTREADER_H
00043 #define Teuchos_XMLPARAMETERLISTREADER_H
00044 
00049 #include "Teuchos_ParameterList.hpp"
00050 #include "Teuchos_XMLObject.hpp"
00051 #include "Teuchos_Utils.hpp"
00052 #include "Teuchos_DependencySheet.hpp"
00053 #include "Teuchos_ValidatorMaps.hpp"
00054 
00055 
00056 namespace Teuchos {
00057 
00058 
00063 class TEUCHOS_LIB_DLL_EXPORT XMLParameterListReader{
00064 
00065 public:
00066   
00069 
00071   typedef std::map<ParameterEntry::ParameterEntryID,
00072     RCP<ParameterEntry> > EntryIDsMap;
00073 
00075 
00077 
00078 
00079   XMLParameterListReader();
00081 
00083   RCP<ParameterList> toParameterList(
00084     const XMLObject& xml, RCP<DependencySheet> depSheet) const;
00085 
00087   ParameterList toParameterList(const XMLObject& xml) const;
00088 
00089 
00090 private:
00091 
00095   void convertParameterList(const XMLObject& xml,
00096     RCP<ParameterList> parentList,
00097     EntryIDsMap& entryIDsMap, const IDtoValidatorMap& validatorIDsMap) const;
00098 
00100   void convertValidators(
00101     const XMLObject& xml, IDtoValidatorMap& validatorIDsMap) const;
00102 
00104   void convertDependencies(
00105     RCP<DependencySheet> depSheet, 
00106     const XMLObject& xml, 
00107     const EntryIDsMap& entryIDsMap,
00108     const IDtoValidatorMap& validatorIDsMap) const;
00109 
00111   void testForDuplicateValidatorIDs(
00112     ParameterEntryValidator::ValidatorID potentialNewID,
00113     const IDtoValidatorMap& currentMap) const;
00114 
00116   void insertEntryIntoMap(
00117     const XMLObject& xmlObj,
00118     RCP<ParameterEntry> entryToInsert,
00119     EntryIDsMap& entryIDsMap) const;
00120 
00121 };
00122 
00123 
00124 
00125 } // namespace Teuchos
00126 
00127 
00128 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines