Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ParameterEntryXMLConverter.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_PARAMETERENTRYXMLCONVERTER_HPP
43 #define TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
44 
45 
52 #include "Teuchos_XMLObject.hpp"
53 #include "Teuchos_Describable.hpp"
55 
56 
57 namespace Teuchos {
58 
62 
63 public:
64 
67 
73  ParameterEntry fromXMLtoParameterEntry(const XMLObject &xmlObj) const;
74 
81  XMLObject fromParameterEntrytoXML(
83  const std::string &name,
85  const ValidatortoIDMap& validatorIDsMap) const;
86 
87  virtual any getAny(const XMLObject& xmlObj) const=0;
88 
90 
92 
93 
100  virtual const std::string getTypeAttributeValue() const=0;
101 
110  virtual const std::string getValueAttributeValue(
111  RCP<const ParameterEntry > entry) const=0;
112 
114  static const std::string& getTypeAttributeName() {
115  static const std::string typeAttributeName_ = "type";
116  return typeAttributeName_;
117  }
118 
120  static const std::string& getIdAttributeName() {
121  static const std::string idAttributeName_ = "id";
122  return idAttributeName_;
123  }
124 
126  static const std::string& getValueAttributeName() {
127  static const std::string valueAttributeName_ = "value";
128  return valueAttributeName_;
129  }
130 
132 
133 private:
134 
137 
139  static const std::string& getDefaultAttributeName() {
140  static const std::string defaultAttributeName_ = "isDefault";
141  return defaultAttributeName_;
142  }
143 
145  static const std::string& getUsedAttributeName() {
146  static const std::string usedAttributeName_ = "isUsed";
147  return usedAttributeName_;
148  }
149 
151  static const std::string& getDocStringAttributeName() {
152  static const std::string docStringAttributeName_ = "docString";
153  return docStringAttributeName_;
154  }
155 
157 
158 };
159 
160 
161 } // namespace Teuchos
162 
163 
164 #endif // TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
Object held as the &quot;value&quot; in the Teuchos::ParameterList std::map.
This object is held as the &quot;value&quot; in the Teuchos::ParameterList std::map.
Modified boost::any class, which is a container for a templated value.
A class used to convert parameter entries to xml and vice versa.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
Writes a ParameterList to an XML object.
A class for mapping validators to integers.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
Base class for all objects that can describe themselves.
Smart reference counting pointer class for automatic garbage collection.
An object representation of a subset of XML data.