Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_FunctionObjectXMLConverter.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Teuchos: Common Tools Package
4 //
5 // Copyright 2004 NTESS and the Teuchos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef TEUCHOS_FUNCTIONOBJECTXMLCONVERTER_HPP
11 #define TEUCHOS_FUNCTIONOBJECTXMLCONVERTER_HPP
12 
18 #include "Teuchos_XMLObject.hpp"
19 #include "Teuchos_Describable.hpp"
24 
25 
26 namespace Teuchos {
27 
28 
33 
34 public:
35 
38 
44  RCP<FunctionObject> fromXMLtoFunctionObject(const XMLObject& xmlObj) const;
45 
53  virtual RCP<FunctionObject> convertXML(const XMLObject& xmlObj) const=0;
54 
60  XMLObject fromFunctionObjecttoXML(
61  const RCP<const FunctionObject> function) const;
62 
69  virtual void convertFunctionObject(
70  const RCP<const FunctionObject> function,
71  XMLObject& xmlObj) const = 0;
72 
74 
76 
77 
79  static const std::string& getTypeAttributeName(){
80  static const std::string typeAttributeName = "type";
81  return typeAttributeName;
82  }
83 
85 
86 };
87 
88 
89 } // namespace Teuchos
90 
91 
92 #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.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
An abstract base class for converting FunctionObjects to and from XML.
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.