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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @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:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4972 byte(s)
Log Message:	updated copyright notices
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* 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	gezelter	1390	*
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	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	246	*/
42
43			/**
44			* @file MinimizerFactory.hpp
45			* @author Teng Lin
46			* @date 10/24/2004
47			* @version 1.0
48			*/
49			#ifndef MINIMIZERS_MINIMIZERFACTORY_HPP
50			#define MINIMIZERS_MINIMIZERFACTORY_HPP
51			#include <cassert>
52			#include <map>
53			#include <string>
54			#include <vector>
55			#include <iostream>
56	gezelter	1390	namespace OpenMD {
57	gezelter	246
58	gezelter	507	//forward declaration
59			class Minimizer;
60			class MinimizerCreator;
61			class SimInfo;
62			/**
63			* @class MinimizerFactory MinimizerFactory.hpp "UseTheForce/MinimizerFactory.hpp"
64			* Factory pattern and Singleton Pattern are used to define an interface for creating an Minimizer.
65			*/
66			class MinimizerFactory {
67			public:
68	gezelter	246
69	gezelter	507	typedef std::map<std::string, MinimizerCreator*> CreatorMapType;
70			typedef std::vector<std::string> IdentVectorType;
71			typedef std::vector<std::string>::iterator IdentVectorIterator;
72	gezelter	246
73	gezelter	507	~MinimizerFactory();
74	gezelter	246
75	gezelter	507	/**
76			* Returns an instance of Minimizer factory
77			* @return an instance of Minimizer factory
78			*/
79			static MinimizerFactory* getInstance() {
80	gezelter	246
81	gezelter	507	if (instance_ == NULL) {
82			instance_ = new MinimizerFactory();
83			}
84			return instance_;
85	gezelter	246
86	gezelter	507	}
87	gezelter	246
88	gezelter	507	/**
89			* Registers a creator with a type identifier
90			* @return true if registration is succeed, otherwise return false
91			* @id the identification of the concrete object
92			* @creator the object responsible to create the concrete object
93			*/
94			bool registerMinimizer(MinimizerCreator* creator);
95	gezelter	246
96	gezelter	507	/**
97			* Unregisters the creator for the given type identifier. If the type identifier
98			* was previously registered, the function returns true.
99			* @return truethe type identifier was previously registered and the creator is removed,
100			* otherwise return false
101			* @id the identification of the concrete object
102			*/
103			bool unregisterMinimizer(const std::string& id);
104			/**
105			* Looks up the type identifier in the internal map. If it is found, it invokes the
106			* corresponding creator for the type identifier and returns its result.
107			* @return a pointer of the concrete object, return NULL if no creator is registed for
108			* creating this concrete object
109			* @param id the identification of the concrete object
110			*/
111			Minimizer* createMinimizer(const std::string& id, SimInfo* info);
112	gezelter	246
113	gezelter	507	/**
114			* Returns all of the registed type identifiers
115			* @return all of the registed type identifiers
116			*/
117			IdentVectorType getIdents();
118	gezelter	246
119	gezelter	507	private:
120			MinimizerFactory() {}
121	gezelter	246
122	gezelter	507	static MinimizerFactory* instance_;
123			CreatorMapType creatorMap_;
124			};
125	gezelter	246
126	gezelter	507	/** write out all of the type identifiers to an output stream */
127			std::ostream& operator <<(std::ostream& o, MinimizerFactory& factory);
128	gezelter	246
129	gezelter	1390	}//namespace OpenMD
130	gezelter	246	#endif //MINIMIZERS_MINIMIZERFACTORY_HPP
131