Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
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
17
18
#include "
Teuchos_XMLObject.hpp
"
19
#include "Teuchos_Describable.hpp"
20
#include "
Teuchos_XMLParameterListExceptions.hpp
"
21
#include "
Teuchos_FunctionObject.hpp
"
22
#include "
Teuchos_XMLParameterListReader.hpp
"
23
#include "
Teuchos_XMLParameterListWriter.hpp
"
24
25
26
namespace
Teuchos
{
27
28
32
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
FunctionObjectXMLConverter
:
public
Describable
{
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
Teuchos_FunctionObject.hpp
An object representation of a function.
Teuchos_XMLObject.hpp
An object representation of a subset of XML data.
Teuchos_XMLParameterListExceptions.hpp
A collection of Exceptions that can be potentially thrown when converting a ParameterList to and from...
Teuchos_XMLParameterListReader.hpp
Writes an XML object to a parameter list.
Teuchos_XMLParameterListWriter.hpp
Writes a ParameterList to an XML object.
Teuchos::Describable
Base class for all objects that can describe themselves.
Definition
Teuchos_Describable.hpp:44
Teuchos::FunctionObjectXMLConverter
An abstract base class for converting FunctionObjects to and from XML.
Definition
Teuchos_FunctionObjectXMLConverter.hpp:32
Teuchos::FunctionObjectXMLConverter::convertXML
virtual RCP< FunctionObject > convertXML(const XMLObject &xmlObj) const =0
Preforms any and all special xml conversion that is specific to a particular FunctionObject.
Teuchos::FunctionObjectXMLConverter::fromFunctionObjecttoXML
XMLObject fromFunctionObjecttoXML(const RCP< const FunctionObject > function) const
Converters a given FunctionObject to XML.
Definition
Teuchos_FunctionObjectXMLConverter.cpp:23
Teuchos::FunctionObjectXMLConverter::getTypeAttributeName
static const std::string & getTypeAttributeName()
Definition
Teuchos_FunctionObjectXMLConverter.hpp:79
Teuchos::FunctionObjectXMLConverter::convertFunctionObject
virtual void convertFunctionObject(const RCP< const FunctionObject > function, XMLObject &xmlObj) const =0
Preforms any and all special FunctionObject conversion that is specific to a particlar FunctionObject...
Teuchos::FunctionObjectXMLConverter::fromXMLtoFunctionObject
RCP< FunctionObject > fromXMLtoFunctionObject(const XMLObject &xmlObj) const
Converts a given XMLObject to a FunctionObject.
Definition
Teuchos_FunctionObjectXMLConverter.cpp:16
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:397
Teuchos::XMLObject
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Definition
Teuchos_XMLObject.hpp:30
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Generated by
1.17.0