Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_FunctionObjectXMLConverterDB.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_FUNTIONOBJECTXMLCONVERTERDB_HPP
44 #define TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
45 
50 // All includes needed for convience macros below
54 
55 
56 namespace Teuchos {
57 
62 
63 public:
64 
67 
74  static void addConverter(
76  RCP<FunctionObjectXMLConverter> converterToAdd);
77 
79 
82 
92  getConverter(const FunctionObject& function);
93 
101  getConverter(const XMLObject& xmlObject);
102 
110  static XMLObject convertFunctionObject(RCP<const FunctionObject> function);
111 
120  static RCP<FunctionObject> convertXML(const XMLObject& xmlObject);
122 
125 
131  static void printKnownConverters(std::ostream& out){
132  out << "Known ConditionXMLConverters: " << std::endl;
133  for(
134  ConverterMap::const_iterator it = getConverterMap().begin();
135  it != getConverterMap().end();
136  ++it)
137  {
138  out << "\t" << it->first <<std::endl;
139  }
140  }
141 
143 
144 private:
145 
148 
150  typedef std::map<std::string, RCP<FunctionObjectXMLConverter> > ConverterMap;
151 
153  typedef std::pair<std::string, RCP<FunctionObjectXMLConverter> > ConverterPair;
154 
158  static ConverterMap& getConverterMap();
159 
161 
162 };
163 
164 
165 } // end namespace Teuchos
166 
167 //
168 // Helper Macros
169 //
170 
174 #define TEUCHOS_ADD_SIMPLEFUNCTIONCONVERTERS(T) \
175  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
176  Teuchos::rcp(new Teuchos::SubtractionFunction< T >), \
177  Teuchos::DummyObjectGetter<Teuchos::SubtractionFunctionXMLConverter< T > >:: \
178  getDummyObject()); \
179  \
180  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
181  Teuchos::rcp(new Teuchos::AdditionFunction< T >), \
182  Teuchos::DummyObjectGetter<Teuchos::AdditionFunctionXMLConverter< T > >:: \
183  getDummyObject()); \
184  \
185  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
186  Teuchos::rcp(new Teuchos::MultiplicationFunction< T >), \
187  Teuchos::DummyObjectGetter<Teuchos::MultiplicationFunctionXMLConverter< T > >:: \
188  getDummyObject()); \
189  \
190  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
191  Teuchos::rcp(new Teuchos::DivisionFunction< T >), \
192  Teuchos::DummyObjectGetter<Teuchos::DivisionFunctionXMLConverter< T > >:: \
193  getDummyObject()); \
194  \
195 
196 #endif // TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
A collection of standard FunctionObjectXMLConverters.
std::pair< std::string, RCP< FunctionObjectXMLConverter > > ConverterPair
convience typedef.
Provides ability to lookup FunctionObjectXMLConverters.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
static void printKnownConverters(std::ostream &out)
prints the xml tags associated with all known converters
Smart reference counting pointer class for automatic garbage collection.
A function object represents an arbitrary function.
std::map< std::string, RCP< FunctionObjectXMLConverter > > ConverterMap
convience class.