Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
18 #include "Teuchos_XMLObject.hpp"
19 #include "Teuchos_Describable.hpp"
20 #include "Teuchos_Condition.hpp"
23 
24 
25 namespace Teuchos {
26 
27 
32 
33 public:
34 
37 
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
Writes an XML object to a parameter list.
An object to determin if a particular set of conditions are occuring.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
Writes a ParameterList to an XML object.
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
An abstract base class for converting Dependencies to and from XML.
Base class for all objects that can describe themselves.
Smart reference counting pointer class for automatic garbage collection.
static const std::string & getTypeAttributeName()
Returns the string to be used for the type attribute.
An object representation of a subset of XML data.