Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_ConditionXMLConverterDB.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_CONDITIONXMLCONVERTERDB_HPP
11
#define TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
12
16
17
// Both includes needed for convience macros below
18
#include "
Teuchos_StandardConditionXMLConverters.hpp
"
19
#include "
Teuchos_StandardConditions.hpp
"
20
21
22
namespace
Teuchos
{
23
24
class
Condition
;
25
28
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
ConditionXMLConverterDB
{
29
30
public
:
31
34
41
static
void
addConverter
(
RCP<const Condition>
condition,
42
RCP<ConditionXMLConverter>
converterToAdd);
43
45
48
57
static
RCP<const ConditionXMLConverter>
58
getConverter
(
const
Condition
& condition);
59
66
static
RCP<const ConditionXMLConverter>
67
getConverter
(
const
XMLObject
& xmlObject);
68
79
static
XMLObject
convertCondition
(
80
RCP<const Condition>
condition,
81
const
XMLParameterListWriter::EntryIDsMap
& entryIDsMap);
82
93
static
RCP<Condition>
convertXML
(
94
const
XMLObject
& xmlObject,
95
const
XMLParameterListReader::EntryIDsMap
& entryIDsMap);
96
98
101
107
static
void
printKnownConverters
(std::ostream& out){
108
out <<
"Known ConditionXMLConverters: "
<< std::endl;
109
for
(
110
ConverterMap::const_iterator it = getConverterMap().begin();
111
it != getConverterMap().end();
112
++it)
113
{
114
out <<
"\t"
<< it->first <<std::endl;
115
}
116
}
117
119
120
private
:
121
124
126
typedef
std::map<std::string, RCP<ConditionXMLConverter> > ConverterMap;
127
129
typedef
std::pair<std::string, RCP<ConditionXMLConverter> > ConverterPair;
130
134
static
ConverterMap& getConverterMap();
135
137
138
};
139
140
141
}
// end namespace Teuchos
142
143
//
144
// Helper Macros
145
//
146
148
#define TEUCHOS_ADD_NUMBERCONDITION_CONVERTER(T) \
149
Teuchos::ConditionXMLConverterDB::addConverter( \
150
Teuchos::DummyObjectGetter<Teuchos::NumberCondition< T > >:: \
151
getDummyObject(), \
152
Teuchos::rcp(new Teuchos::NumberConditionConverter< T >));
153
154
#endif
// TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
Teuchos_StandardConditionXMLConverters.hpp
A collection of standard ConditionXMLConverters.
Teuchos_StandardConditions.hpp
Standard Conditions to be used.
Teuchos::Condition
A Condition determines whether or not a particular set of conditions are currently occuring.
Definition
Teuchos_Condition.hpp:28
Teuchos::ConditionXMLConverterDB
Provides ability to lookup ConditionXMLConverters.
Definition
Teuchos_ConditionXMLConverterDB.hpp:28
Teuchos::ConditionXMLConverterDB::getConverter
static RCP< const ConditionXMLConverter > getConverter(const Condition &condition)
Get an appropriate ConditionXMLConverter given a Condition.
Definition
Teuchos_ConditionXMLConverterDB.cpp:28
Teuchos::ConditionXMLConverterDB::convertXML
static RCP< Condition > convertXML(const XMLObject &xmlObject, const XMLParameterListReader::EntryIDsMap &entryIDsMap)
Given an XMLObject and IDtoConditionMap, converts the XMLObject to a Condition.
Definition
Teuchos_ConditionXMLConverterDB.cpp:63
Teuchos::ConditionXMLConverterDB::printKnownConverters
static void printKnownConverters(std::ostream &out)
prints the xml tags associated with all known converters
Definition
Teuchos_ConditionXMLConverterDB.hpp:107
Teuchos::ConditionXMLConverterDB::addConverter
static void addConverter(RCP< const Condition > condition, RCP< ConditionXMLConverter > converterToAdd)
Add a converter to the database.
Definition
Teuchos_ConditionXMLConverterDB.cpp:19
Teuchos::ConditionXMLConverterDB::convertCondition
static XMLObject convertCondition(RCP< const Condition > condition, const XMLParameterListWriter::EntryIDsMap &entryIDsMap)
Given a condition and ConditiontoIDMap, converts the condition to XML.
Definition
Teuchos_ConditionXMLConverterDB.cpp:56
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