src/minimizers/MinimizerFactory.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 MinimizerFactory.hpp
 * @author Teng Lin
 * @date 10/24/2004
 * @version 1.0
 */
#ifndef MINIMIZERS_MINIMIZERFACTORY_HPP
#define MINIMIZERS_MINIMIZERFACTORY_HPP
#include <cassert>
#include <map>
#include <string>
#include <vector>
#include <iostream>
namespace oopse {

//forward declaration
class Minimizer;
class MinimizerCreator;
class SimInfo;
/**
 * @class MinimizerFactory MinimizerFactory.hpp "UseTheForce/MinimizerFactory.hpp"
 * Factory pattern and Singleton Pattern are used to define an interface for creating an Minimizer.
 */
class MinimizerFactory {
    public:
                
        typedef std::map<std::string, MinimizerCreator*> CreatorMapType;
        typedef std::vector<std::string> IdentVectorType;
        typedef std::vector<std::string>::iterator IdentVectorIterator;

        ~MinimizerFactory();
                    
        /**
         * Returns an instance of Minimizer factory
         * @return an instance of Minimizer factory
         */        
        static MinimizerFactory* getInstance() {

            if (instance_ == NULL) {
                instance_ = new MinimizerFactory();
            }
            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 registerMinimizer(MinimizerCreator* 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 unregisterMinimizer(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
         */
        Minimizer* createMinimizer(const std::string& id, SimInfo* info);

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

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

}//namespace oopse
#endif //MINIMIZERS_MINIMIZERFACTORY_HPP

Revision:	1913
Committed:	Mon Jan 10 22:04:20 2005 UTC (19 years, 7 months ago) by tim
File size:	4111 byte(s)
Log Message:	create a register module to register force fields, integrators and minimizers
#	User	Rev	Content
1	tim	1902	/*
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 MinimizerFactory.hpp
28			* @author Teng Lin
29			* @date 10/24/2004
30			* @version 1.0
31			*/
32			#ifndef MINIMIZERS_MINIMIZERFACTORY_HPP
33			#define MINIMIZERS_MINIMIZERFACTORY_HPP
34			#include <cassert>
35			#include <map>
36			#include <string>
37			#include <vector>
38			#include <iostream>
39			namespace oopse {
40
41			//forward declaration
42			class Minimizer;
43			class MinimizerCreator;
44			class SimInfo;
45			/**
46			* @class MinimizerFactory MinimizerFactory.hpp "UseTheForce/MinimizerFactory.hpp"
47			* Factory pattern and Singleton Pattern are used to define an interface for creating an Minimizer.
48			*/
49			class MinimizerFactory {
50			public:
51
52			typedef std::map<std::string, MinimizerCreator*> CreatorMapType;
53			typedef std::vector<std::string> IdentVectorType;
54			typedef std::vector<std::string>::iterator IdentVectorIterator;
55	tim	1913
56			~MinimizerFactory();
57	tim	1902
58			/**
59			* Returns an instance of Minimizer factory
60			* @return an instance of Minimizer factory
61			*/
62			static MinimizerFactory* getInstance() {
63
64			if (instance_ == NULL) {
65			instance_ = new MinimizerFactory();
66			}
67			return instance_;
68
69			}
70
71			/**
72			* Registers a creator with a type identifier
73			* @return true if registration is succeed, otherwise return false
74			* @id the identification of the concrete object
75			* @creator the object responsible to create the concrete object
76			*/
77			bool registerMinimizer(MinimizerCreator* creator);
78
79			/**
80			* Unregisters the creator for the given type identifier. If the type identifier
81			* was previously registered, the function returns true.
82			* @return truethe type identifier was previously registered and the creator is removed,
83			* otherwise return false
84			* @id the identification of the concrete object
85			*/
86			bool unregisterMinimizer(const std::string& id);
87			/**
88			* Looks up the type identifier in the internal map. If it is found, it invokes the
89			* corresponding creator for the type identifier and returns its result.
90			* @return a pointer of the concrete object, return NULL if no creator is registed for
91			* creating this concrete object
92			* @param id the identification of the concrete object
93			*/
94			Minimizer* createMinimizer(const std::string& id, SimInfo* info);
95
96			/**
97			* Returns all of the registed type identifiers
98			* @return all of the registed type identifiers
99			*/
100			IdentVectorType getIdents();
101
102			private:
103	tim	1913	MinimizerFactory() {}
104
105	tim	1902	static MinimizerFactory* instance_;
106			CreatorMapType creatorMap_;
107			};
108
109			/** write out all of the type identifiers to an output stream */
110			std::ostream& operator <<(std::ostream& o, MinimizerFactory& factory);
111
112			}//namespace oopse
113			#endif //MINIMIZERS_MINIMIZERFACTORY_HPP
114