ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/minimizers/MinimizerFactory.hpp
(Generate patch)

Comparing trunk/src/minimizers/MinimizerFactory.hpp (file contents):
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 1390 by gezelter, Wed Nov 25 20:02:06 2009 UTC

# Line 1 | Line 1
1 < /*
1 > /*
2   * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3   *
4   * The University of Notre Dame grants you ("Licensee") a
# Line 6 | Line 6
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
9 > * 1. Redistributions of source code must retain the above copyright
10   *    notice, this list of conditions and the following disclaimer.
11   *
12 < * 3. Redistributions in binary form must reproduce the above copyright
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.
# Line 37 | Line 28
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   /**
# Line 52 | Line 52
52   #include <string>
53   #include <vector>
54   #include <iostream>
55 < namespace oopse {
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:
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;
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();
72 >    ~MinimizerFactory();
73                      
74 <        /**
75 <         * Returns an instance of Minimizer factory
76 <         * @return an instance of Minimizer factory
77 <         */        
78 <        static MinimizerFactory* getInstance() {
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_;
80 >      if (instance_ == NULL) {
81 >        instance_ = new MinimizerFactory();
82 >      }
83 >      return instance_;
84              
85 <        }
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);
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);
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();
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() {}
118 >  private:
119 >    MinimizerFactory() {}
120          
121 <        static MinimizerFactory* instance_;
122 <        CreatorMapType creatorMap_;
123 < };
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);
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
128 > }//namespace OpenMD
129   #endif //MINIMIZERS_MINIMIZERFACTORY_HPP
130  

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines