--- trunk/OOPSE-4/src/utils/GenericFactory.hpp 2004/10/25 04:08:14 1642 +++ trunk/OOPSE-4/src/utils/GenericFactory.hpp 2005/01/12 22:41:40 1930 @@ -1,28 +1,44 @@ -/* - * 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 GenericFactory.hpp * @author Teng Lin @@ -31,6 +47,7 @@ */ #ifndef UTIL_GENERICFACTORY_HPP #define UTIL_GENERICFACTORY_HPP +#include #include #include #include @@ -43,10 +60,10 @@ namespace oopse { * 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 string - * @param Creator the callable entity that creates objects. This type must support operator(), + * @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 { @@ -67,7 +84,9 @@ namespace oopse { * } * * //register createLine - * ShapeFactory::getInstance()->registerCreator("Line", 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{ @@ -80,12 +99,45 @@ namespace oopse { * } * * //register createCircle - * ShapeFactory::getInstance()->registerCreator("Circle", 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 { @@ -135,6 +187,7 @@ class GenericFactory { 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; @@ -161,7 +214,7 @@ class GenericFactory { CreatorMapType creatorMap_; }; -/** write out all of the type identifier to a output stream */ +/** write out all of the type identifiers to an output stream */ template std::ostream& operator <<(std::ostream& o, GenericFactory& factory) { std::vector idents; @@ -181,11 +234,16 @@ GenericFactory* GenericFacto template GenericFactory* GenericFactory::instance_ ; + #define DECLARE_CREATOR(abstractObject, concreteObject) \ - abstractObject* create##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