Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_ParameterEntryXMLConverterDB.hpp
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
43#ifndef TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
44#define TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
45
49
50
56namespace Teuchos {
57
60class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryXMLConverterDB {
61public:
62
65
70 static void addConverter(RCP<ParameterEntryXMLConverter> converterToAdd){
71 getConverterMap().insert(
72 ConverterPair(converterToAdd->getTypeAttributeValue(), converterToAdd));
73 }
74
76
79
80
86 getConverter(RCP<const ParameterEntry> entry);
87
93 getConverter(const XMLObject& xmlObject);
94
96 static RCP<const ParameterEntryXMLConverter> getDefaultConverter();
97
99
100 // 2010/07/30: rabarlt: The above two functions should be moved into
101 // Teuchos_ParameterEntryXMLConvergerDB.cpp. These functions don't need to
102 // be inlined and it will be easier to set breakpoints in the debugger if
103 // they are in a *.cpp file.
104
107
113 const std::string& name,
115 const ValidatortoIDMap& validatorIDsMap)
116 {
117 return getConverter(entry)->fromParameterEntrytoXML(
118 entry, name, id, validatorIDsMap);
119 }
120
124 static ParameterEntry convertXML(const XMLObject& xmlObj)
125 {
126 return getConverter(xmlObj)->fromXMLtoParameterEntry(xmlObj);
127 }
128
130
133
139 static void printKnownConverters(std::ostream& out);
141
142private:
143
146
148 typedef std::map<std::string, RCP<ParameterEntryXMLConverter> > ConverterMap;
149
151 typedef std::pair<std::string, RCP<ParameterEntryXMLConverter> > ConverterPair;
152
154
156 static ConverterMap& getConverterMap();
157
158
159};
160
161
162} // namespace Teuchos
163
164//
165// Helper Macros
166//
167
168
172#define TEUCHOS_ADD_TYPE_CONVERTER(T) \
173 \
174 Teuchos::ParameterEntryXMLConverterDB::addConverter( \
175 Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< T >));
176
180#define TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T) \
181 Teuchos::ParameterEntryXMLConverterDB::addConverter( \
182 Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::Array< T > >)); \
183 Teuchos::ParameterEntryXMLConverterDB::addConverter( \
184 Teuchos::rcp(new Teuchos::StandardTemplatedParameterConverter< Teuchos::TwoDArray< T > >));
185
189#define TEUCHOS_ADD_TYPE_AND_ARRAYTYPE_CONVERTER(T) \
190 \
191 TEUCHOS_ADD_TYPE_CONVERTER(T); \
192 TEUCHOS_ADD_ARRAYTYPE_CONVERTER(T);
193
194
195#endif // TEUCHOS_PARAMETERENTRYXMLCONVERTERDB_HPP
A collection of standard ParameterEntryXMLConverters.
A collection of Exceptions that can be potentially thrown when converting a ParameterList to and from...
Writes a ParameterList to an XML object.
Provides ability to lookup ParameterEntryXMLConverters.
static XMLObject convertEntry(RCP< const ParameterEntry > entry, const std::string &name, const ParameterEntry::ParameterEntryID &id, const ValidatortoIDMap &validatorIDsMap)
Converts the given ParameterEntry to XML.
static void addConverter(RCP< ParameterEntryXMLConverter > converterToAdd)
Add a converter to the database.
static ParameterEntry convertXML(const XMLObject &xmlObj)
Converts XML to a ParameterEntry.
This object is held as the "value" in the Teuchos::ParameterList std::map.
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,...
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...