Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_FunctionObjectXMLConverter.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_FUNCTIONOBJECTXMLCONVERTER_HPP
43 #define TEUCHOS_FUNCTIONOBJECTXMLCONVERTER_HPP
44 
50 #include "Teuchos_XMLObject.hpp"
51 #include "Teuchos_Describable.hpp"
56 
57 
58 namespace Teuchos {
59 
60 
64 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT FunctionObjectXMLConverter : public Describable {
65 
66 public:
67 
70 
76  RCP<FunctionObject> fromXMLtoFunctionObject(const XMLObject& xmlObj) const;
77 
85  virtual RCP<FunctionObject> convertXML(const XMLObject& xmlObj) const=0;
86 
92  XMLObject fromFunctionObjecttoXML(
93  const RCP<const FunctionObject> function) const;
94 
101  virtual void convertFunctionObject(
102  const RCP<const FunctionObject> function,
103  XMLObject& xmlObj) const = 0;
104 
106 
108 
109 
111  static const std::string& getTypeAttributeName(){
112  static const std::string typeAttributeName = "type";
113  return typeAttributeName;
114  }
115 
117 
118 };
119 
120 
121 } // namespace Teuchos
122 
123 
124 #endif // TEUCHOS_FUNCTIONOBJECTXMLCONVERTER_HPP
Writes an XML object to a parameter list.
An object representation of a function.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
Writes a ParameterList to an XML object.
An abstract base class for converting FunctionObjects to and from XML.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.
A collection of Exceptions that can be potentially thrown when converting a ParameterList to and from...
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.