Teuchos Package Browser (Single Doxygen Collection)
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
//
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_CONDITIONXMLCONVERTER_HPP
43
#define TEUCHOS_CONDITIONXMLCONVERTER_HPP
44
49
50
#include "
Teuchos_XMLObject.hpp
"
51
#include "
Teuchos_Describable.hpp
"
52
#include "
Teuchos_Condition.hpp
"
53
#include "
Teuchos_XMLParameterListReader.hpp
"
54
#include "
Teuchos_XMLParameterListWriter.hpp
"
55
56
57
namespace
Teuchos
{
58
59
63
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
ConditionXMLConverter
:
public
Describable
{
64
65
public
:
66
69
77
RCP<Condition>
78
fromXMLtoCondition
(
79
const
XMLObject
& xmlObj,
80
const
XMLParameterListReader::EntryIDsMap
& entryIDsMap)
const
;
81
91
virtual
RCP<Condition>
convertXML
(
92
const
XMLObject
& xmlObj,
93
const
XMLParameterListReader::EntryIDsMap
& entryIDsMap)
const
=0;
94
102
XMLObject
fromConditiontoXML
(
103
const
RCP<const Condition>
condition,
104
const
XMLParameterListWriter::EntryIDsMap
& entryIDsMap)
const
;
105
116
virtual
void
convertCondition
(
117
const
RCP<const Condition>
condition,
118
XMLObject
& xmlObj,
119
const
XMLParameterListWriter::EntryIDsMap
& entryIDsMap)
const
= 0;
120
122
124
125
127
static
const
std::string&
getTypeAttributeName
(){
128
static
const
std::string typeAttributeName =
"type"
;
129
return
typeAttributeName;
130
}
131
133
134
};
135
136
137
}
// namespace Teuchos
138
139
140
#endif
// TEUCHOS_CONDITIONXMLCONVERTER_HPP
Teuchos_Condition.hpp
An object to determin if a particular set of conditions are occuring.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
Definition
Teuchos_DLLExportMacro.h:29
Teuchos_Describable.hpp
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:63
Teuchos::ConditionXMLConverter::getTypeAttributeName
static const std::string & getTypeAttributeName()
Returns the string to be used for the type attribute.
Definition
Teuchos_ConditionXMLConverter.hpp:127
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:56
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:49
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:76
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:429
Teuchos::XMLObject
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Definition
Teuchos_XMLObject.hpp:62
Teuchos::XMLParameterListReader::EntryIDsMap
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
Definition
Teuchos_XMLParameterListReader.hpp:72
Teuchos::XMLParameterListWriter::EntryIDsMap
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
Definition
Teuchos_XMLParameterListWriter.hpp:73
Teuchos
Definition
Teuchos_AbstractFactory.hpp:47
Generated by
1.17.0