src/minimizers/MinimizerFactory.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. 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 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:	246
Committed:	Wed Jan 12 22:41:40 2005 UTC (20 years, 9 months ago) by gezelter
File size:	5041 byte(s)
Log Message:	merging new_design branch into OOPSE-2.0
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* 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	* 1. Acknowledgement of the program authors must be made in any
10	* publication of scientific results based in part on use of the
11	* program. An acceptable form of acknowledgement is citation of
12	* the article in which the program was described (Matthew
13	* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14	* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15	* Parallel Simulation Engine for Molecular Dynamics,"
16	* J. Comput. Chem. 26, pp. 252-271 (2005))
17	*
18	* 2. Redistributions of source code must retain the above copyright
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
41
42	/**
43	* @file MinimizerFactory.hpp
44	* @author Teng Lin
45	* @date 10/24/2004
46	* @version 1.0
47	*/
48	#ifndef MINIMIZERS_MINIMIZERFACTORY_HPP
49	#define MINIMIZERS_MINIMIZERFACTORY_HPP
50	#include <cassert>
51	#include <map>
52	#include <string>
53	#include <vector>
54	#include <iostream>
55	namespace oopse {
56
57	//forward declaration
58	class Minimizer;
59	class MinimizerCreator;
60	class SimInfo;
61	/**
62	* @class MinimizerFactory MinimizerFactory.hpp "UseTheForce/MinimizerFactory.hpp"
63	* Factory pattern and Singleton Pattern are used to define an interface for creating an Minimizer.
64	*/
65	class MinimizerFactory {
66	public:
67
68	typedef std::map<std::string, MinimizerCreator*> CreatorMapType;
69	typedef std::vector<std::string> IdentVectorType;
70	typedef std::vector<std::string>::iterator IdentVectorIterator;
71
72	~MinimizerFactory();
73
74	/**
75	* Returns an instance of Minimizer factory
76	* @return an instance of Minimizer factory
77	*/
78	static MinimizerFactory* getInstance() {
79
80	if (instance_ == NULL) {
81	instance_ = new MinimizerFactory();
82	}
83	return instance_;
84
85	}
86
87	/**
88	* Registers a creator with a type identifier
89	* @return true if registration is succeed, otherwise return false
90	* @id the identification of the concrete object
91	* @creator the object responsible to create the concrete object
92	*/
93	bool registerMinimizer(MinimizerCreator* creator);
94
95	/**
96	* Unregisters the creator for the given type identifier. If the type identifier
97	* was previously registered, the function returns true.
98	* @return truethe type identifier was previously registered and the creator is removed,
99	* otherwise return false
100	* @id the identification of the concrete object
101	*/
102	bool unregisterMinimizer(const std::string& id);
103	/**
104	* Looks up the type identifier in the internal map. If it is found, it invokes the
105	* corresponding creator for the type identifier and returns its result.
106	* @return a pointer of the concrete object, return NULL if no creator is registed for
107	* creating this concrete object
108	* @param id the identification of the concrete object
109	*/
110	Minimizer* createMinimizer(const std::string& id, SimInfo* info);
111
112	/**
113	* Returns all of the registed type identifiers
114	* @return all of the registed type identifiers
115	*/
116	IdentVectorType getIdents();
117
118	private:
119	MinimizerFactory() {}
120
121	static MinimizerFactory* instance_;
122	CreatorMapType creatorMap_;
123	};
124
125	/** write out all of the type identifiers to an output stream */
126	std::ostream& operator <<(std::ostream& o, MinimizerFactory& factory);
127
128	}//namespace oopse
129	#endif //MINIMIZERS_MINIMIZERFACTORY_HPP
130