Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_ConditionXMLConverterDB.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
43#ifndef TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
44#define TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
45
50// Both includes needed for convience macros below
53
54
55namespace Teuchos {
56
57class Condition;
58
62
63public:
64
67
74 static void addConverter(RCP<const Condition> condition,
75 RCP<ConditionXMLConverter> converterToAdd);
76
78
81
91 getConverter(const Condition& condition);
92
100 getConverter(const XMLObject& xmlObject);
101
112 static XMLObject convertCondition(
113 RCP<const Condition> condition,
114 const XMLParameterListWriter::EntryIDsMap& entryIDsMap);
115
126 static RCP<Condition> convertXML(
127 const XMLObject& xmlObject,
128 const XMLParameterListReader::EntryIDsMap& entryIDsMap);
129
131
134
140 static void printKnownConverters(std::ostream& out){
141 out << "Known ConditionXMLConverters: " << std::endl;
142 for(
143 ConverterMap::const_iterator it = getConverterMap().begin();
144 it != getConverterMap().end();
145 ++it)
146 {
147 out << "\t" << it->first <<std::endl;
148 }
149 }
150
152
153private:
154
157
159 typedef std::map<std::string, RCP<ConditionXMLConverter> > ConverterMap;
160
162 typedef std::pair<std::string, RCP<ConditionXMLConverter> > ConverterPair;
163
167 static ConverterMap& getConverterMap();
168
170
171};
172
173
174} // end namespace Teuchos
175
176//
177// Helper Macros
178//
179
181#define TEUCHOS_ADD_NUMBERCONDITION_CONVERTER(T) \
182 Teuchos::ConditionXMLConverterDB::addConverter( \
183 Teuchos::DummyObjectGetter<Teuchos::NumberCondition< T > >:: \
184 getDummyObject(), \
185 Teuchos::rcp(new Teuchos::NumberConditionConverter< T >));
186
187#endif // TEUCHOS_CONDITIONXMLCONVERTERDB_HPP
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
A collection of standard ConditionXMLConverters.
Standard Conditions to be used.
Provides ability to lookup ConditionXMLConverters.
std::pair< std::string, RCP< ConditionXMLConverter > > ConverterPair
convience typedef.
std::map< std::string, RCP< ConditionXMLConverter > > ConverterMap
convience class.
static void printKnownConverters(std::ostream &out)
prints the xml tags associated with all known converters
A Condition determines whether or not a particular set of conditions are currently occuring.
Smart reference counting pointer class for automatic garbage collection.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap