Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_XMLParameterListReader.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef Teuchos_XMLPARAMETERLISTREADER_H
43 #define Teuchos_XMLPARAMETERLISTREADER_H
44 
50 #include "Teuchos_XMLObject.hpp"
51 #include "Teuchos_Utils.hpp"
54 
55 
56 namespace Teuchos {
57 
58 
64 
65 public:
66 
69 
71  typedef std::map<ParameterEntry::ParameterEntryID,
73 
75 
77 
78 
81 
83  RCP<ParameterList> toParameterList(
84  const XMLObject& xml, RCP<DependencySheet> depSheet) const;
85 
87  ParameterList toParameterList(const XMLObject& xml) const;
88 
103  void setAllowsDuplicateSublists(bool policy);
104 
108  bool getAllowsDuplicateSublists() const;
109 
110 private:
111 
113 
117  void convertParameterList(const XMLObject& xml,
118  RCP<ParameterList> parentList,
119  EntryIDsMap& entryIDsMap, const IDtoValidatorMap& validatorIDsMap) const;
120 
122  void convertValidators(
123  const XMLObject& xml, IDtoValidatorMap& validatorIDsMap) const;
124 
126  void convertDependencies(
127  RCP<DependencySheet> depSheet,
128  const XMLObject& xml,
129  const EntryIDsMap& entryIDsMap,
130  const IDtoValidatorMap& validatorIDsMap) const;
131 
133  void testForDuplicateValidatorIDs(
135  const IDtoValidatorMap& currentMap) const;
136 
138  void insertEntryIntoMap(
139  const XMLObject& xmlObj,
140  RCP<ParameterEntry> entryToInsert,
141  EntryIDsMap& entryIDsMap) const;
142 
143 };
144 
145 
146 
147 } // namespace Teuchos
148 
149 
150 #endif
Maps Validators to integers.
Templated Parameter List class.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
A list of parameters of arbitrary type.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
DataStructure keeping track of dependencies.
Writes an XML object to a parameter list.
Smart reference counting pointer class for automatic garbage collection.
A utilities class for Teuchos.
An object representation of a subset of XML data.