Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_XMLParameterListWriter.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_XMLPARAMETERLISTWRITER_H
43#define Teuchos_XMLPARAMETERLISTWRITER_H
44
45
52#include "Teuchos_XMLObject.hpp"
53#include "Teuchos_Utils.hpp"
56
57
58namespace Teuchos {
59
60
64class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT XMLParameterListWriter {
65
66public:
67
70
72 typedef std::map<RCP<const ParameterEntry>,
74
76
78
79
82
84 XMLObject toXML(
85 const ParameterList& p,
86 RCP<const DependencySheet> depSheet = null) const;
87
89 static const std::string& getParameterListTagName(){
90 static const std::string parameterListTagName = "ParameterList";
91 return parameterListTagName;
92 }
93
95 static const std::string& getNameAttributeName(){
96 static const std::string nameAttributeName = "name";
97 return nameAttributeName;
98 }
99
101 static const std::string& getValidatorsTagName(){
102 static const std::string validatorsTagName = "Validators";
103 return validatorsTagName;
104 }
105
107 static const std::string& getDependenciesTagName(){
108 static const std::string dependenciesTagName = "Dependencies";
109 return dependenciesTagName;
110 }
111
112private:
113
115 XMLObject convertParameterList(
116 const ParameterList& p,
118 EntryIDsMap& entryIDsMap,
119 const ValidatortoIDMap& validatorIDsMap) const;
120
122 XMLObject convertValidators(
123 const ParameterList& p,
124 ValidatortoIDMap& validatorIDsMap) const;
125
127 XMLObject convertDependencies(
129 const EntryIDsMap& entryIDsMap,
130 ValidatortoIDMap& validatorIDsMap) const;
131
133 void buildInitialValidatorMap(
134 const ParameterList& p,
135 ValidatortoIDMap& validatorIDsMap) const;
136};
137
138
139} // namespace teuchos
140
141
142#endif
DataStructure keeping track of dependencies.
Templated Parameter List class.
A utilities class for Teuchos.
An object representation of a subset of XML data.
A list of parameters of arbitrary type.
Smart reference counting pointer class for automatic garbage collection.
A class for mapping validators to integers.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Writes a ParameterList to an XML object.
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
static const std::string & getDependenciesTagName()
static const std::string & getValidatorsTagName()
static const std::string & getParameterListTagName()
static const std::string & getNameAttributeName()
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Struct for comparing two RCPs. Simply compares the raw pointers contained within the RCPs.