src/integrators/IntegratorFactory.hpp

/*
 * 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.
 *
 */

/**
 * @file IntegratorFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef INTEGRATORS_INTEGRATORFACTORY_HPP
#define INTEGRATORS_INTEGRATORFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>

namespace oopse {

//forward declaration
class Integrator;
class SimInfo;
/**
 * @class IntegratorFactory IntegratorFactory.hpp "integrators/IntegratorFactory.hpp"
 * Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator.
 * @note we can actually use GenericFactory
 */
class IntegratorFactory {
    public:

        /** a function pointer which has not parameter and return a pointer pointer to a Integrator instance*/
        typedef Integrator* (*IntegratorCreatorType)(SimInfo*);         
        
        typedef std::map<std::string, IntegratorCreatorType> CreatorMapType;
        typedef std::vector<std::string> IdentVectorType;
        typedef std::vector<std::string>::iterator IdentVectorIterator;
                    
        /**
         * Returns an instance of Integrator factory
         * @return an instance of Integrator factory
         */        
        static IntegratorFactory* 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 registerIntegrator(const std::string& id, IntegratorCreatorType 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 unregisterIntegrator(const std::string& 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
         */
        Integrator* createIntegrator(const std::string& id);

        /** 
         *  Returns all of the registed  type identifiers
         * @return all of the registed  type identifiers
         */
        IdentVectorType getIdents();
        
    private:
        static IntegratorFactory* instance_;
        CreatorMapType creatorMap_;
};

/** write out all of the type identifiers to an output stream */
std::ostream& operator <<(std::ostream& o, IntegratorFactory& factory);

}//namespace oopse
#endif //INTEGRATORS_INTEGRATORFACTORY_HPP
Revision:	1758
Committed:	Fri Nov 19 17:56:32 2004 UTC (19 years, 9 months ago) by tim
File size:	4099 byte(s)
Log Message:	DUFF is almost done except error checking
#	User	Rev	Content
1	tim	1758	/*
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.
23			*
24			*/
25
26			/**
27			* @file IntegratorFactory.hpp
28			* @author Teng Lin
29			* @date 10/24/2004
30			* @version 1.0
31			*/
32			#ifndef INTEGRATORS_INTEGRATORFACTORY_HPP
33			#define INTEGRATORS_INTEGRATORFACTORY_HPP
34			#include <cassert>
35			#include <map>
36			#include <string>
37			#include <vector>
38
39			namespace oopse {
40
41			//forward declaration
42			class Integrator;
43			class SimInfo;
44			/**
45			* @class IntegratorFactory IntegratorFactory.hpp "integrators/IntegratorFactory.hpp"
46			* Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator.
47			* @note we can actually use GenericFactory
48			*/
49			class IntegratorFactory {
50			public:
51
52			/** a function pointer which has not parameter and return a pointer pointer to a Integrator instance*/
53			typedef Integrator* (IntegratorCreatorType)(SimInfo);
54
55			typedef std::map<std::string, IntegratorCreatorType> CreatorMapType;
56			typedef std::vector<std::string> IdentVectorType;
57			typedef std::vector<std::string>::iterator IdentVectorIterator;
58
59			/**
60			* Returns an instance of Integrator factory
61			* @return an instance of Integrator factory
62			*/
63			static IntegratorFactory* getInstance();
64
65			/**
66			* Registers a creator with a type identifier
67			* @return true if registration is succeed, otherwise return false
68			* @id the identification of the concrete object
69			* @creator the object responsible to create the concrete object
70			*/
71			bool registerIntegrator(const std::string& id, IntegratorCreatorType creator);
72
73			/**
74			* Unregisters the creator for the given type identifier. If the type identifier
75			* was previously registered, the function returns true.
76			* @return truethe type identifier was previously registered and the creator is removed,
77			* otherwise return false
78			* @id the identification of the concrete object
79			*/
80			bool unregisterIntegrator(const std::string& id);
81			/**
82			* Looks up the type identifier in the internal map. If it is found, it invokes the
83			* corresponding creator for the type identifier and returns its result.
84			* @return a pointer of the concrete object, return NULL if no creator is registed for
85			* creating this concrete object
86			* @param id the identification of the concrete object
87			*/
88			Integrator* createIntegrator(const std::string& id);
89
90			/**
91			* Returns all of the registed type identifiers
92			* @return all of the registed type identifiers
93			*/
94			IdentVectorType getIdents();
95
96			private:
97			static IntegratorFactory* instance_;
98			CreatorMapType creatorMap_;
99			};
100
101			/** write out all of the type identifiers to an output stream */
102			std::ostream& operator <<(std::ostream& o, IntegratorFactory& factory);
103
104			}//namespace oopse
105			#endif //INTEGRATORS_INTEGRATORFACTORY_HPP