--- trunk/OOPSE-4/src/utils/GenericFactory.hpp 2004/10/18 05:23:21 1587 +++ trunk/OOPSE-4/src/utils/GenericFactory.hpp 2005/01/12 22:41:40 1930 @@ -1,64 +1,249 @@ -/* - * Copyright (C) 2000-2004 Object Oriented Parallel Simulation Engine (OOPSE) project - * - * Contact: oopse@oopse.org - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 2.1 - * of the License, or (at your option) any later version. - * All we ask is that proper credit is given for our work, which includes - * - but is not limited to - adding the above copyright notice to the beginning - * of your source code files, and to any copyright notice that you may distribute - * with programs based on this work. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + /* + * 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. Acknowledgement of the program authors must be made in any + * publication of scientific results based in part on use of the + * program. An acceptable form of acknowledgement is citation of + * the article in which the program was described (Matthew + * A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher + * J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented + * Parallel Simulation Engine for Molecular Dynamics," + * J. Comput. Chem. 26, pp. 252-271 (2005)) + * + * 2. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 3. 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. */ - + /** - * @file Vector3.hpp + * @file GenericFactory.hpp * @author Teng Lin - * @date 09/14/2004 + * @date 10/24/2004 * @version 1.0 */ #ifndef UTIL_GENERICFACTORY_HPP #define UTIL_GENERICFACTORY_HPP +#include #include #include +#include -template -class GenericFactory{ +namespace oopse { + +/** + * @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 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 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 GenericFactory { public: + typedef GenericFactory FactoryType; + typedef std::map CreatorMapType; - typedef map CreatorMapType; - ~GenericFactory(); + /** + * Returns an instance of object factory + * @return an instance of object factory + */ + static FactoryType* getInstance(){ + if (instance_ == NULL) + instance_ = new FactoryType; + return instance_; + } - static GenericFactory* getInstance(); + /** + * 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; + } - bool register(CreatorType* creator); + /** + * 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; + } - bool unregister(); - - bool hasCreator( const ProductIdentType& id ); + /** + * 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; + } + } - const std::string toString(); + /** + * Returns all of the registed type identifiers + * @return all of the registed type identifiers + */ + std::vector getIdents() { + std::vector idents; + typename CreatorMapType::iterator i; - Product* createProduct( const ProductIdentType& id ); - - private: - GenericFactory(){} - static GenericFactory* instance_; - map creatorMap_; + for (i = creatorMap_.begin(); i != creatorMap_.end(); ++i) { + idents.push_back(i->first); + } + + return idents; + } + + public: + static FactoryType* instance_; + CreatorMapType creatorMap_; }; -typedef GenericFactory ForceFiledParserFactory; -#endif +/** write out all of the type identifiers to an output stream */ +template +std::ostream& operator <<(std::ostream& o, GenericFactory& factory) { + std::vector idents; + std::vector::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 +GenericFactory* GenericFactory::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 oopse +#endif //UTIL_GENERICFACTORY_HPP +