| 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 Vector3.hpp |
| 43 |
> |
* @file GenericFactory.hpp |
| 44 |
|
* @author Teng Lin |
| 45 |
< |
* @date 09/14/2004 |
| 45 |
> |
* @date 10/24/2004 |
| 46 |
|
* @version 1.0 |
| 47 |
|
*/ |
| 48 |
|
#ifndef UTIL_GENERICFACTORY_HPP |
| 49 |
|
#define UTIL_GENERICFACTORY_HPP |
| 50 |
+ |
#include <cassert> |
| 51 |
|
#include <map> |
| 52 |
|
#include <string> |
| 53 |
+ |
#include <vector> |
| 54 |
+ |
|
| 55 |
|
namespace oopse { |
| 56 |
< |
template<class Product, typename ProductIdentType = std::string, typename Creator = Product* (*)() > |
| 57 |
< |
class GenericFactory{ |
| 56 |
> |
|
| 57 |
> |
/** |
| 58 |
> |
* @class GenericFactory GenericFactory.hpp "utils/GenericFactory.hpp" |
| 59 |
> |
* @brief GenericFactory is a template based Object Factory |
| 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 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 { |
| 70 |
> |
* ... |
| 71 |
> |
* }; |
| 72 |
> |
* |
| 73 |
> |
* //instantiating a new object factory |
| 74 |
> |
* typedef GenericFactory<Shape> ShapeFactory; |
| 75 |
> |
* |
| 76 |
> |
* //Line class |
| 77 |
> |
* class Line : public Shape{ |
| 78 |
> |
* ... |
| 79 |
> |
* }; |
| 80 |
> |
* |
| 81 |
> |
* //declare function to create Line |
| 82 |
> |
* Shape* createLine() { |
| 83 |
> |
* return new Line; |
| 84 |
> |
* } |
| 85 |
> |
* |
| 86 |
> |
* //register 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{ |
| 93 |
> |
* ... |
| 94 |
> |
* }; |
| 95 |
> |
* |
| 96 |
> |
* //declare function to create Circle |
| 97 |
> |
* Shape* createCircle() { |
| 98 |
> |
* return new Circle; |
| 99 |
> |
* } |
| 100 |
> |
* |
| 101 |
> |
* //register 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 { |
| 144 |
|
public: |
| 145 |
+ |
typedef GenericFactory<Object, IdentType, Creator> FactoryType; |
| 146 |
+ |
typedef std::map<IdentType, Creator> CreatorMapType; |
| 147 |
|
|
| 148 |
< |
typedef std::map<ProductIdentType, Creator*> CreatorMapType; |
| 149 |
< |
typedef GenericFactory<Product, ProductIdentType, Creator> SelfType; |
| 150 |
< |
static SelfType* getInstance() { |
| 151 |
< |
if (instance_ == NULL) { |
| 152 |
< |
instance_ = new GenericFactory<Product, ProductIdentType, Creator>(); |
| 153 |
< |
} |
| 154 |
< |
|
| 148 |
> |
/** |
| 149 |
> |
* Returns an instance of object factory |
| 150 |
> |
* @return an instance of object factory |
| 151 |
> |
*/ |
| 152 |
> |
static FactoryType* getInstance(){ |
| 153 |
> |
if (instance_ == NULL) |
| 154 |
> |
instance_ = new FactoryType; |
| 155 |
|
return instance_; |
| 156 |
|
} |
| 50 |
– |
|
| 51 |
– |
//bool register( const ProductIdentType& id, Creator creator) { |
| 157 |
|
|
| 158 |
< |
//insert method in std::map will return a pair<iterator, bool>. the second |
| 159 |
< |
//element of this pair indicates whether the result of the operation |
| 160 |
< |
//return creatorMap_.insert(CreatorMapType::value_type(id, creator)).second; |
| 161 |
< |
//} |
| 158 |
> |
/** |
| 159 |
> |
* Registers a creator with a type identifier |
| 160 |
> |
* @return true if registration is succeed, otherwise return false |
| 161 |
> |
* @id the identification of the concrete object |
| 162 |
> |
* @creator the object responsible to create the concrete object |
| 163 |
> |
*/ |
| 164 |
> |
bool registerCreator(const IdentType& id, Creator creator) { |
| 165 |
> |
return creatorMap_.insert( |
| 166 |
> |
CreatorMapType::value_type(id, creator)).second; |
| 167 |
> |
} |
| 168 |
|
|
| 169 |
< |
bool unregister(const ProductIdentType& id) { |
| 170 |
< |
|
| 171 |
< |
return creatorMap_->erase(id) == 1; |
| 172 |
< |
|
| 169 |
> |
/** |
| 170 |
> |
* Unregisters the creator for the given type identifier. If the type identifier |
| 171 |
> |
* was previously registered, the function returns true. |
| 172 |
> |
* @return truethe type identifier was previously registered and the creator is removed, |
| 173 |
> |
* otherwise return false |
| 174 |
> |
* @id the identification of the concrete object |
| 175 |
> |
*/ |
| 176 |
> |
bool unregisterCreator(const IdentType& id) { |
| 177 |
> |
return creatorMap_.erase(id) == 1; |
| 178 |
|
} |
| 63 |
– |
|
| 64 |
– |
bool hasCreator( const ProductIdentType& id ) { |
| 65 |
– |
CreatorMapType::iterator i; |
| 179 |
|
|
| 180 |
< |
i = creatorMap_.find(id); |
| 181 |
< |
|
| 180 |
> |
/** |
| 181 |
> |
* Looks up the type identifier in the internal map. If it is found, it invokes the |
| 182 |
> |
* corresponding creator for the type identifier and returns its result. |
| 183 |
> |
* @return a pointer of the concrete object, return NULL if no creator is registed for |
| 184 |
> |
* creating this concrete object |
| 185 |
> |
* @param id the identification of the concrete object |
| 186 |
> |
*/ |
| 187 |
> |
Object* createObject(const IdentType& id) { |
| 188 |
> |
typename CreatorMapType::iterator i = creatorMap_.find(id); |
| 189 |
|
if (i != creatorMap_.end()) { |
| 190 |
< |
return true; |
| 190 |
> |
//invoke functor to create object |
| 191 |
> |
return (i->second)(); |
| 192 |
|
} else { |
| 193 |
< |
return false; |
| 193 |
> |
return NULL; |
| 194 |
|
} |
| 195 |
|
} |
| 196 |
|
|
| 197 |
< |
//const std::string toString() { |
| 197 |
> |
/** |
| 198 |
> |
* Returns all of the registed type identifiers |
| 199 |
> |
* @return all of the registed type identifiers |
| 200 |
> |
*/ |
| 201 |
> |
std::vector<IdentType> getIdents() { |
| 202 |
> |
std::vector<IdentType> idents; |
| 203 |
> |
typename CreatorMapType::iterator i; |
| 204 |
|
|
| 205 |
< |
|
| 206 |
< |
//} |
| 80 |
< |
|
| 81 |
< |
Product* createProduct( const ProductIdentType& id ) { |
| 82 |
< |
CreatorMapType::iterator i; |
| 83 |
< |
|
| 84 |
< |
i = creatorMap_.find(id); |
| 85 |
< |
|
| 86 |
< |
if (i != creatorMap_.end()) { |
| 87 |
< |
//call the function to create the product |
| 88 |
< |
return (i->second)(); |
| 89 |
< |
} else { |
| 90 |
< |
return NULL; |
| 205 |
> |
for (i = creatorMap_.begin(); i != creatorMap_.end(); ++i) { |
| 206 |
> |
idents.push_back(i->first); |
| 207 |
|
} |
| 208 |
+ |
|
| 209 |
+ |
return idents; |
| 210 |
|
} |
| 211 |
< |
|
| 212 |
< |
private: |
| 213 |
< |
GenericFactory(){} |
| 96 |
< |
static SelfType* instance_; |
| 211 |
> |
|
| 212 |
> |
public: |
| 213 |
> |
static FactoryType* instance_; |
| 214 |
|
CreatorMapType creatorMap_; |
| 215 |
|
}; |
| 216 |
|
|
| 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; |
| 221 |
+ |
std::vector<I>::iterator i; |
| 222 |
|
|
| 223 |
< |
#define REGISTER_CREATOR(factory, product, id) \ |
| 224 |
< |
product * create##product() {\ |
| 225 |
< |
return new product(); \ |
| 223 |
> |
idents = factory.getIdents(); |
| 224 |
> |
|
| 225 |
> |
o << "Avaliable type identifiers in this factory: " << std::endl; |
| 226 |
> |
for (i = idents.begin(); i != idents.end(); ++i) { |
| 227 |
> |
o << *i << std::endl; |
| 228 |
|
} |
| 229 |
|
|
| 230 |
+ |
return o; |
| 231 |
+ |
} |
| 232 |
+ |
|
| 233 |
+ |
//static template class member |
| 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 |
+ |
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 |
|
|
