Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_ConditionXMLConverter.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_CONDITIONXMLCONVERTER_HPP
11
#define TEUCHOS_CONDITIONXMLCONVERTER_HPP
12
17
18
#include "
Teuchos_XMLObject.hpp
"
19
#include "Teuchos_Describable.hpp"
20
#include "
Teuchos_Condition.hpp
"
21
#include "
Teuchos_XMLParameterListReader.hpp
"
22
#include "
Teuchos_XMLParameterListWriter.hpp
"
23
24
25
namespace
Teuchos
{
26
27
31
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
ConditionXMLConverter
:
public
Describable
{
32
33
public
:
34
37
45
RCP<Condition>
46
fromXMLtoCondition
(
47
const
XMLObject
& xmlObj,
48
const
XMLParameterListReader::EntryIDsMap
& entryIDsMap)
const
;
49
59
virtual
RCP<Condition>
convertXML
(
60
const
XMLObject
& xmlObj,
61
const
XMLParameterListReader::EntryIDsMap
& entryIDsMap)
const
=0;
62
70
XMLObject
fromConditiontoXML
(
71
const
RCP<const Condition>
condition,
72
const
XMLParameterListWriter::EntryIDsMap
& entryIDsMap)
const
;
73
84
virtual
void
convertCondition
(
85
const
RCP<const Condition>
condition,
86
XMLObject
& xmlObj,
87
const
XMLParameterListWriter::EntryIDsMap
& entryIDsMap)
const
= 0;
88
90
92
93
95
static
const
std::string&
getTypeAttributeName
(){
96
static
const
std::string typeAttributeName =
"type"
;
97
return
typeAttributeName;
98
}
99
101
102
};
103
104
105
}
// namespace Teuchos
106
107
108
#endif
// TEUCHOS_CONDITIONXMLCONVERTER_HPP
Teuchos_Condition.hpp
An object to determin if a particular set of conditions are occuring.
Teuchos_XMLObject.hpp
An object representation of a subset of XML data.
Teuchos_XMLParameterListReader.hpp
Writes an XML object to a parameter list.
Teuchos_XMLParameterListWriter.hpp
Writes a ParameterList to an XML object.
Teuchos::ConditionXMLConverter
An abstract base class for converting Dependencies to and from XML.
Definition
Teuchos_ConditionXMLConverter.hpp:31
Teuchos::ConditionXMLConverter::getTypeAttributeName
static const std::string & getTypeAttributeName()
Returns the string to be used for the type attribute.
Definition
Teuchos_ConditionXMLConverter.hpp:95
Teuchos::ConditionXMLConverter::convertXML
virtual RCP< Condition > convertXML(const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const =0
Preforms any and all special xml conversion that is specific to a particular Condition.
Teuchos::ConditionXMLConverter::fromConditiontoXML
XMLObject fromConditiontoXML(const RCP< const Condition > condition, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const
Converters a given ParameterEntryValidator to XML.
Definition
Teuchos_ConditionXMLConverter.cpp:24
Teuchos::ConditionXMLConverter::fromXMLtoCondition
RCP< Condition > fromXMLtoCondition(const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap) const
Converts a given XMLObject to a Condition.
Definition
Teuchos_ConditionXMLConverter.cpp:17
Teuchos::ConditionXMLConverter::convertCondition
virtual void convertCondition(const RCP< const Condition > condition, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap) const =0
Preforms any and all special condition conversion that is specific to a particlar Condition.
Teuchos::Describable
Base class for all objects that can describe themselves.
Definition
Teuchos_Describable.hpp:44
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::XMLParameterListReader::EntryIDsMap
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
Definition
Teuchos_XMLParameterListReader.hpp:40
Teuchos::XMLParameterListWriter::EntryIDsMap
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
Definition
Teuchos_XMLParameterListWriter.hpp:41
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Generated by
1.17.0