src/utils/GenericFactory.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @file GenericFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef UTIL_GENERICFACTORY_HPP
#define UTIL_GENERICFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>

namespace OpenMD {

  /**
   * @class GenericFactory GenericFactory.hpp "utils/GenericFactory.hpp"
   * @brief GenericFactory is a template based Object Factory 
   * Factory pattern is used to define an interface for creating an object.
   * 
   * @param Object the base class of the hierarchy for which you provide the object factory.
   * @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(),
   * taking no parameters and returning a pointer to Object. Default type is function pointer.
   *
   * Usage:
   * @code
   * //Shape class
   * class Shape {
   * ...
   * };
   * 
   * //instantiating a new object factory
   * typedef GenericFactory<Shape> ShapeFactory;
   *
   * //Line class
   * class Line : public Shape{
   * ...
   * };
   *
   * //declare function to create Line
   * Shape* createLine() {
   *   return new Line;
   * }
   *
   * //register createLine
   * //note: must put ShapeFactory::getInstance()->registerCreator("Line", createLine) on the right
   * //hand side, otherwise the compiler will consider it as a function declaration
   * const bool registeredLine = ShapeFactory::getInstance()->registerCreator("Line", createLine);
   *
   * //Circle class
   * class Circle : public Shape{
   * ...
   * };
   *
   * //declare function to create Circle
   * Shape* createCircle() { 
   *   return new Circle;
   * }
   *
   * //register createCircle
   * const bool registeredCircle = ShapeFactory::getInstance()->registerCreator("Circle", createCircle); 
   *
   * //create object by ident
   * Line* line = ShapeFactory::getInstance()->createObject("Line");
   * Circle* circle = ShapeFactory::getInstance()->createObject("Circle"); 
   * @endcode
   *
   * Or the user can use predefined macro DECLARE_CREATOR and REGISTER_CREATOR
   * @code
   * //Shape class
   * class Shape {
   * ...
   * };
   * 
   * //instantiating a new object factory
   * typedef GenericFactory<Shape> ShapeFactory;
   *
   * //Line class
   * class Line : public Shape{
   * ...
   * };
   *
   * //declare function using macro 
   * DECLARE_CREATOR(Shape, Line)
   * 
   * //register using macro
   * REGISTER_CREATOR(ShapeFactory, "Line", Line);
 
   * //Circle class
   * class Circle : public Shape{
   * ...
   * };
   *
   * //declare function using macro 
   * DECLARE_CREATOR(Shape, Circle)
   * 
   * //register using macro
   * REGISTER_CREATOR(ShapeFactory, "Circle", Circle);
   * @endcode
   */
  template<class Object, typename IdentType = std::string, typename Creator = Object* (*)()>
  class GenericFactory {
  public:
    typedef GenericFactory<Object, IdentType, Creator> FactoryType;
    typedef std::map<IdentType, Creator> CreatorMapType;
        
    /**
     * Returns an instance of object factory
     * @return an instance of object factory
     */        
    static FactoryType* getInstance(){
      if (instance_ == NULL)
        instance_ = new FactoryType;
      return instance_;
    }

    /**
     * Registers a creator with a type identifier
     * @return true if registration is succeed, otherwise return false
     * @id the identification of the concrete object
     * @creator the object responsible to create the concrete object 
     */
    bool registerCreator(const IdentType& id, Creator creator) {
      return creatorMap_.insert(
                                CreatorMapType::value_type(id, creator)).second;
    }

    /**
     * Unregisters the creator for the given type identifier. If the type identifier 
     * was previously registered, the function returns true.
     * @return truethe type identifier was previously registered and the creator is removed,
     * otherwise return false
     * @id the identification of the concrete object
     */
    bool unregisterCreator(const IdentType& id) {
      return creatorMap_.erase(id) == 1;
    }

    /**
     * Looks up the type identifier in the internal map. If it is found, it invokes the
     * corresponding creator for the type identifier and returns its result. 
     * @return a pointer of the concrete object, return NULL if no creator is registed for 
     * creating this concrete object
     * @param id the identification of the concrete object
     */
    Object* createObject(const IdentType& id) {
      typename CreatorMapType::iterator i = creatorMap_.find(id);
      if (i != creatorMap_.end()) {
        //invoke functor to create object
        return (i->second)();
      } else {
        return NULL;
      }
    }

    /** 
     *  Returns all of the registed  type identifiers
     * @return all of the registed  type identifiers
     */
    std::vector<IdentType> getIdents() {
      std::vector<IdentType> idents;
      typename CreatorMapType::iterator i;

      for (i = creatorMap_.begin(); i != creatorMap_.end(); ++i) {
        idents.push_back(i->first);
      }
            
      return idents;
    }

  public:
    static FactoryType* instance_;
    CreatorMapType creatorMap_;
  };

  /** write out all of the type identifiers to an output stream */
  template<typename O, typename I, typename C>
  std::ostream& operator <<(std::ostream& o, GenericFactory<O, I, C>& factory) {
    std::vector<I> idents;
    std::vector<I>::iterator i;

    idents = factory.getIdents();

    o << "Avaliable type identifiers in this factory: " << std::endl;
    for (i = idents.begin(); i != idents.end(); ++i) {
      o << *i << std::endl;
    }

    return o;
  }

  //static template class member
  template<class Object, typename IdentType,typename Creator>
  GenericFactory<Object,IdentType,Creator>* GenericFactory<Object,IdentType,Creator>::instance_ ; 


#define DECLARE_CREATOR(abstractObject, concreteObject) \
  inline abstractObject* create##concreteObject(){      \
    return new concreteObject;                          \
  }

#define REGISTER_CREATOR(factory, ident, concreteObject)                \
  const bool registered##concreteObject = factory::getInstance()->registerCreator(ident, create##concreteObject); 


}//namespace OpenMD
#endif //UTIL_GENERICFACTORY_HPP

Revision:	1442
Committed:	Mon May 10 17:28:26 2010 UTC (14 years, 11 months ago) by gezelter
Original Path:	*trunk/src/utils/GenericFactory.hpp*
File size:	8414 byte(s)
Log Message:	Adding property set to svn entries
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	94	*
4	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31	gezelter	1390	*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39			* [4] Vardeman & Gezelter, in progress (2009).
40	tim	94	*/
41	gezelter	246
42	tim	94	/**
43	tim	148	* @file GenericFactory.hpp
44	tim	94	* @author Teng Lin
45	tim	148	* @date 10/24/2004
46	tim	94	* @version 1.0
47			*/
48			#ifndef UTIL_GENERICFACTORY_HPP
49			#define UTIL_GENERICFACTORY_HPP
50	tim	150	#include <cassert>
51	tim	94	#include <map>
52			#include <string>
53	tim	148	#include <vector>
54
55	gezelter	1390	namespace OpenMD {
56	tim	148
57	gezelter	507	/**
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	tim	150
130	gezelter	507	* //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	tim	94
148	gezelter	507	/**
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			}
157	tim	94
158	gezelter	507	/**
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	tim	94
169	gezelter	507	/**
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			}
179	tim	94
180	gezelter	507	/**
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			//invoke functor to create object
191			return (i->second)();
192			} else {
193			return NULL;
194			}
195			}
196	tim	99
197	gezelter	507	/**
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	tim	99
205	gezelter	507	for (i = creatorMap_.begin(); i != creatorMap_.end(); ++i) {
206			idents.push_back(i->first);
207			}
208	tim	148
209	gezelter	507	return idents;
210			}
211	tim	148
212	gezelter	507	public:
213			static FactoryType* instance_;
214			CreatorMapType creatorMap_;
215			};
216	tim	94
217	gezelter	507	/** 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	tim	148	std::vector<I> idents;
221			std::vector<I>::iterator i;
222	tim	94
223	tim	148	idents = factory.getIdents();
224
225			o << "Avaliable type identifiers in this factory: " << std::endl;
226			for (i = idents.begin(); i != idents.end(); ++i) {
227	gezelter	507	o << *i << std::endl;
228	tim	99	}
229
230	tim	148	return o;
231	gezelter	507	}
232	tim	148
233	gezelter	507	//static template class member
234			template<class Object, typename IdentType,typename Creator>
235			GenericFactory<Object,IdentType,Creator>* GenericFactory<Object,IdentType,Creator>::instance_ ;
236	tim	148
237	tim	150
238	tim	148	#define DECLARE_CREATOR(abstractObject, concreteObject) \
239	gezelter	507	inline abstractObject* create##concreteObject(){ \
240			return new concreteObject; \
241			}
242	tim	148
243	gezelter	507	#define REGISTER_CREATOR(factory, ident, concreteObject) \
244			const bool registered##concreteObject = factory::getInstance()->registerCreator(ident, create##concreteObject);
245	tim	150
246
247	gezelter	1390	}//namespace OpenMD
248	tim	99	#endif //UTIL_GENERICFACTORY_HPP
249