1 |
< |
/* |
2 |
< |
* Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project |
3 |
< |
* |
4 |
< |
* Contact: oopse@oopse.org |
5 |
< |
* |
6 |
< |
* This program is free software; you can redistribute it and/or |
7 |
< |
* modify it under the terms of the GNU Lesser General Public License |
8 |
< |
* as published by the Free Software Foundation; either version 2.1 |
9 |
< |
* of the License, or (at your option) any later version. |
10 |
< |
* All we ask is that proper credit is given for our work, which includes |
11 |
< |
* - but is not limited to - adding the above copyright notice to the beginning |
12 |
< |
* of your source code files, and to any copyright notice that you may distribute |
13 |
< |
* with programs based on this work. |
14 |
< |
* |
15 |
< |
* This program is distributed in the hope that it will be useful, |
16 |
< |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 |
< |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 |
< |
* GNU Lesser General Public License for more details. |
19 |
< |
* |
20 |
< |
* You should have received a copy of the GNU Lesser General Public License |
21 |
< |
* along with this program; if not, write to the Free Software |
22 |
< |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
1 |
> |
/* |
2 |
> |
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
3 |
|
* |
4 |
+ |
* The University of Notre Dame grants you ("Licensee") a |
5 |
+ |
* non-exclusive, royalty free, license to use, modify and |
6 |
+ |
* redistribute this software in source and binary code form, provided |
7 |
+ |
* that the following conditions are met: |
8 |
+ |
* |
9 |
+ |
* 1. Acknowledgement of the program authors must be made in any |
10 |
+ |
* publication of scientific results based in part on use of the |
11 |
+ |
* program. An acceptable form of acknowledgement is citation of |
12 |
+ |
* the article in which the program was described (Matthew |
13 |
+ |
* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher |
14 |
+ |
* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented |
15 |
+ |
* Parallel Simulation Engine for Molecular Dynamics," |
16 |
+ |
* J. Comput. Chem. 26, pp. 252-271 (2005)) |
17 |
+ |
* |
18 |
+ |
* 2. Redistributions of source code must retain the above copyright |
19 |
+ |
* notice, this list of conditions and the following disclaimer. |
20 |
+ |
* |
21 |
+ |
* 3. Redistributions in binary form must reproduce the above copyright |
22 |
+ |
* notice, this list of conditions and the following disclaimer in the |
23 |
+ |
* documentation and/or other materials provided with the |
24 |
+ |
* distribution. |
25 |
+ |
* |
26 |
+ |
* This software is provided "AS IS," without a warranty of any |
27 |
+ |
* kind. All express or implied conditions, representations and |
28 |
+ |
* warranties, including any implied warranty of merchantability, |
29 |
+ |
* fitness for a particular purpose or non-infringement, are hereby |
30 |
+ |
* excluded. The University of Notre Dame and its licensors shall not |
31 |
+ |
* be liable for any damages suffered by licensee as a result of |
32 |
+ |
* using, modifying or distributing the software or its |
33 |
+ |
* derivatives. In no event will the University of Notre Dame or its |
34 |
+ |
* licensors be liable for any lost revenue, profit or data, or for |
35 |
+ |
* direct, indirect, special, consequential, incidental or punitive |
36 |
+ |
* damages, however caused and regardless of the theory of liability, |
37 |
+ |
* arising out of the use of or inability to use software, even if the |
38 |
+ |
* University of Notre Dame has been advised of the possibility of |
39 |
+ |
* such damages. |
40 |
|
*/ |
41 |
< |
|
41 |
> |
|
42 |
|
/** |
43 |
|
* @file GenericFactory.hpp |
44 |
|
* @author Teng Lin |
47 |
|
*/ |
48 |
|
#ifndef UTIL_GENERICFACTORY_HPP |
49 |
|
#define UTIL_GENERICFACTORY_HPP |
50 |
+ |
#include <cassert> |
51 |
|
#include <map> |
52 |
|
#include <string> |
53 |
|
#include <vector> |
60 |
|
* Factory pattern is used to define an interface for creating an object. |
61 |
|
* |
62 |
|
* @param Object the base class of the hierarchy for which you provide the object factory. |
63 |
< |
* @param IdentType the object that identifies the type of the concrete object. Default type is string |
47 |
< |
* @param Creator the callable entity that creates objects. This type must support operator(), |
63 |
> |
* @param IdentType the object that identifies the type of the concrete object. Default type is std::string * @param Creator the callable entity that creates objects. This type must support operator(), |
64 |
|
* taking no parameters and returning a pointer to Object. Default type is function pointer. |
65 |
|
* |
66 |
+ |
* Usage: |
67 |
|
* @code |
68 |
|
* //Shape class |
69 |
|
* class Shape { |
84 |
|
* } |
85 |
|
* |
86 |
|
* //register createLine |
87 |
< |
* ShapeFactory::getInstance()->registerCreator("Line", createLine); |
87 |
> |
* //note: must put ShapeFactory::getInstance()->registerCreator("Line", createLine) on the right |
88 |
> |
* //hand side, otherwise the compiler will consider it as a function declaration |
89 |
> |
* const bool registeredLine = ShapeFactory::getInstance()->registerCreator("Line", createLine); |
90 |
|
* |
91 |
|
* //Circle class |
92 |
|
* class Circle : public Shape{ |
99 |
|
* } |
100 |
|
* |
101 |
|
* //register createCircle |
102 |
< |
* ShapeFactory::getInstance()->registerCreator("Circle", createCircle); |
102 |
> |
* const bool registeredCircle = ShapeFactory::getInstance()->registerCreator("Circle", createCircle); |
103 |
|
* |
104 |
|
* //create object by ident |
105 |
|
* Line* line = ShapeFactory::getInstance()->createObject("Line"); |
106 |
|
* Circle* circle = ShapeFactory::getInstance()->createObject("Circle"); |
107 |
|
* @endcode |
108 |
+ |
* |
109 |
+ |
* Or the user can use predefined macro DECLARE_CREATOR and REGISTER_CREATOR |
110 |
+ |
* @code |
111 |
+ |
* //Shape class |
112 |
+ |
* class Shape { |
113 |
+ |
* ... |
114 |
+ |
* }; |
115 |
+ |
* |
116 |
+ |
* //instantiating a new object factory |
117 |
+ |
* typedef GenericFactory<Shape> ShapeFactory; |
118 |
+ |
* |
119 |
+ |
* //Line class |
120 |
+ |
* class Line : public Shape{ |
121 |
+ |
* ... |
122 |
+ |
* }; |
123 |
+ |
* |
124 |
+ |
* //declare function using macro |
125 |
+ |
* DECLARE_CREATOR(Shape, Line) |
126 |
+ |
* |
127 |
+ |
* //register using macro |
128 |
+ |
* REGISTER_CREATOR(ShapeFactory, "Line", Line); |
129 |
+ |
|
130 |
+ |
* //Circle class |
131 |
+ |
* class Circle : public Shape{ |
132 |
+ |
* ... |
133 |
+ |
* }; |
134 |
+ |
* |
135 |
+ |
* //declare function using macro |
136 |
+ |
* DECLARE_CREATOR(Shape, Circle) |
137 |
+ |
* |
138 |
+ |
* //register using macro |
139 |
+ |
* REGISTER_CREATOR(ShapeFactory, "Circle", Circle); |
140 |
+ |
* @endcode |
141 |
|
*/ |
142 |
|
template<class Object, typename IdentType = std::string, typename Creator = Object* (*)()> |
143 |
|
class GenericFactory { |
187 |
|
Object* createObject(const IdentType& id) { |
188 |
|
typename CreatorMapType::iterator i = creatorMap_.find(id); |
189 |
|
if (i != creatorMap_.end()) { |
190 |
+ |
//invoke functor to create object |
191 |
|
return (i->second)(); |
192 |
|
} else { |
193 |
|
return NULL; |
214 |
|
CreatorMapType creatorMap_; |
215 |
|
}; |
216 |
|
|
217 |
< |
/** write out all of the type identifier to a output stream */ |
217 |
> |
/** write out all of the type identifiers to an output stream */ |
218 |
|
template<typename O, typename I, typename C> |
219 |
|
std::ostream& operator <<(std::ostream& o, GenericFactory<O, I, C>& factory) { |
220 |
|
std::vector<I> idents; |
234 |
|
template<class Object, typename IdentType,typename Creator> |
235 |
|
GenericFactory<Object,IdentType,Creator>* GenericFactory<Object,IdentType,Creator>::instance_ ; |
236 |
|
|
237 |
+ |
|
238 |
|
#define DECLARE_CREATOR(abstractObject, concreteObject) \ |
239 |
< |
abstractObject* create##concreteObject(){\ |
239 |
> |
inline abstractObject* create##concreteObject(){\ |
240 |
|
return new concreteObject;\ |
241 |
|
} |
242 |
|
|
243 |
+ |
#define REGISTER_CREATOR(factory, ident, concreteObject) \ |
244 |
+ |
const bool registered##concreteObject = factory::getInstance()->registerCreator(ident, create##concreteObject); |
245 |
+ |
|
246 |
+ |
|
247 |
|
}//namespace oopse |
248 |
|
#endif //UTIL_GENERICFACTORY_HPP |
249 |
|
|