Teuchos - Trilinos Tools Package Version of the Day
Teuchos_XMLParameterListWriter.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_XMLPARAMETERLISTWRITER_H
00043 #define Teuchos_XMLPARAMETERLISTWRITER_H
00044 
00045 
00051 #include "Teuchos_ParameterList.hpp"
00052 #include "Teuchos_XMLObject.hpp"
00053 #include "Teuchos_Utils.hpp"
00054 #include "Teuchos_DependencySheet.hpp"
00055 #include "Teuchos_ValidatorMaps.hpp"
00056 
00057 
00058 namespace Teuchos {
00059 
00060 
00064 class TEUCHOS_LIB_DLL_EXPORT XMLParameterListWriter {
00065 
00066 public:
00067 
00070 
00072   typedef std::map<RCP<const ParameterEntry>,
00073     ParameterEntry::ParameterEntryID, RCPConstComp> EntryIDsMap;
00074   
00076 
00078 
00079 
00080   XMLParameterListWriter();
00082 
00084   XMLObject toXML(
00085     const ParameterList& p, 
00086     RCP<const DependencySheet> depSheet = null) const;
00087 
00089   static const std::string& getParameterListTagName(){
00090     static const std::string parameterListTagName = "ParameterList";
00091     return parameterListTagName;
00092   }
00093 
00095   static const std::string& getNameAttributeName(){
00096     static const std::string nameAttributeName = "name";
00097     return nameAttributeName;
00098   } 
00099 
00101   static const std::string& getValidatorsTagName(){
00102     static const std::string validatorsTagName = "Validators";
00103     return validatorsTagName;
00104   }
00105 
00107   static const std::string& getDependenciesTagName(){
00108     static const std::string dependenciesTagName = "Dependencies";
00109     return dependenciesTagName;
00110   }
00111 
00112 private:
00113 
00115   XMLObject convertParameterList(
00116       const ParameterList& p, 
00117       ParameterEntry::ParameterEntryID& idCounter, 
00118       EntryIDsMap& entryIDsMap,
00119       const ValidatortoIDMap& validatorIDsMap) const;
00120 
00122   XMLObject convertValidators(
00123     const ParameterList& p, 
00124     ValidatortoIDMap& validatorIDsMap) const;
00125 
00127   XMLObject convertDependencies(
00128     RCP<const DependencySheet> depSheet,
00129     const EntryIDsMap& entryIDsMap, 
00130     ValidatortoIDMap& validatorIDsMap) const;
00131 
00133   void buildInitialValidatorMap(
00134     const ParameterList& p,
00135     ValidatortoIDMap& validatorIDsMap) const;
00136 };
00137 
00138 
00139 } // namespace teuchos
00140 
00141 
00142 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines