Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_DependencyXMLConverter.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_DEPENDENCYXMLCONVERTER_HPP
43 #define TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
44 
50 #include "Teuchos_Dependency.hpp"
51 #include "Teuchos_XMLObject.hpp"
54 #include "Teuchos_Describable.hpp"
55 
56 
57 namespace Teuchos {
58 
59 
63 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DependencyXMLConverter : public Describable {
64 
65 public:
66 
69 
79  RCP<Dependency> fromXMLtoDependency(
80  const XMLObject& xmlObj,
81  const XMLParameterListReader::EntryIDsMap& entryIDsMap,
82  const IDtoValidatorMap& validatorIDsMap) const;
83 
97  virtual RCP<Dependency> convertXML(
98  const XMLObject& xmlObj,
100  const Dependency::ParameterEntryList dependets,
101  const XMLParameterListReader::EntryIDsMap& entryIDsMap,
102  const IDtoValidatorMap& validatorIDsMap) const = 0;
103 
113  XMLObject fromDependencytoXML(
114  const RCP<const Dependency> dependency,
115  const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
116  ValidatortoIDMap& validatorIDsMap) const;
117 
130  virtual void convertDependency(
131  const RCP<const Dependency> dependency,
132  XMLObject& xmlObj,
133  const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
134  ValidatortoIDMap& validatorIDsMap) const = 0;
135 
137 
139 
140 
144  static const std::string& getDependeeTagName(){
145  static const std::string dependeeTagName = "Dependee";
146  return dependeeTagName;
147  }
148 
152  static const std::string& getDependentTagName(){
153  static const std::string dependentTagName = "Dependent";
154  return dependentTagName;
155  }
156 
160  static const std::string& getParameterIdAttributeName(){
161  static const std::string parameterIdAtrributeName = "parameterId";
162  return parameterIdAtrributeName;
163  }
164 
168  static const std::string& getTypeAttributeName(){
169  static const std::string typeAttributeName = "type";
170  return typeAttributeName;
171  }
172 
174 
175 };
176 
177 
178 } // namespace Teuchos
179 
180 
181 #endif // TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
Writes an XML object to a parameter list.
Maps Validators to integers.
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
static const std::string & getTypeAttributeName()
Returns the string to be used for the type attribute.
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
static const std::string & getDependeeTagName()
Returns the string to be used for the dependee tag.
An abstract base class for converting Dependencies to and from XML.
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 & getParameterIdAttributeName()
Returns the string to be used for the ParameterID attribute.
static const std::string & getDependentTagName()
Returns the string to be used for the dependent tag.
A class for mapping validators to integers.
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
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.