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. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @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 OpenMD {

  //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 OpenMD
#endif //MINIMIZERS_MINIMIZERFACTORY_HPP

Revision:	1390
Committed:	Wed Nov 25 20:02:06 2009 UTC (15 years, 6 months ago) by gezelter
File size:	4906 byte(s)
Log Message:	Almost all of the changes necessary to create OpenMD out of our old project (OOPSE-4)
#	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. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the
15	* distribution.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
28	* arising out of the use of or inability to use software, even if the
29	* University of Notre Dame has been advised of the possibility of
30	* such damages.
31	*
32	* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33	* research, please cite the appropriate papers when you publish your
34	* work. Good starting points are:
35	*
36	* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37	* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39	* [4] Vardeman & Gezelter, in progress (2009).
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 OpenMD {
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 OpenMD
129	#endif //MINIMIZERS_MINIMIZERFACTORY_HPP
130