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

Comparing trunk/src/lattice/LatticeFactory.hpp (file contents):
Revision 484 by tim, Tue Apr 12 21:58:09 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 Lattice;
59 < class LatticeCreator;
60 < /**
61 < * @class LatticeFactory LatticeFactory.hpp "UseTheForce/LatticeFactory.hpp"
62 < * Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
63 < */
64 < class LatticeFactory {
65 <    public:
57 >  //forward declaration
58 >  class Lattice;
59 >  class LatticeCreator;
60 >  /**
61 >   * @class LatticeFactory LatticeFactory.hpp "UseTheForce/LatticeFactory.hpp"
62 >   * Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
63 >   */
64 >  class LatticeFactory {
65 >  public:
66                  
67 <        typedef std::map<std::string, LatticeCreator*> CreatorMapType;
68 <        typedef std::vector<std::string> IdentVectorType;
69 <        typedef std::vector<std::string>::iterator IdentVectorIterator;
67 >    typedef std::map<std::string, LatticeCreator*> CreatorMapType;
68 >    typedef std::vector<std::string> IdentVectorType;
69 >    typedef std::vector<std::string>::iterator IdentVectorIterator;
70  
71 <        ~LatticeFactory();
71 >    ~LatticeFactory();
72                      
73 <        /**
74 <         * Returns an instance of Lattice factory
75 <         * @return an instance of Lattice factory
76 <         */        
77 <        static LatticeFactory* getInstance() {
73 >    /**
74 >     * Returns an instance of Lattice factory
75 >     * @return an instance of Lattice factory
76 >     */        
77 >    static LatticeFactory* getInstance() {
78  
79 <            if (instance_ == NULL) {
80 <                instance_ = new LatticeFactory();
81 <            }
82 <            return instance_;
79 >      if (instance_ == NULL) {
80 >        instance_ = new LatticeFactory();
81 >      }
82 >      return instance_;
83              
84 <        }
84 >    }
85  
86 <        /**
87 <         * Registers a creator with a type identifier
88 <         * @return true if registration is succeed, otherwise return false
89 <         * @id the identification of the concrete object
90 <         * @creator the object responsible to create the concrete object
91 <         */
92 <        bool registerLattice(LatticeCreator* creator);
86 >    /**
87 >     * Registers a creator with a type identifier
88 >     * @return true if registration is succeed, otherwise return false
89 >     * @id the identification of the concrete object
90 >     * @creator the object responsible to create the concrete object
91 >     */
92 >    bool registerLattice(LatticeCreator* creator);
93  
94 <        /**
95 <         * Unregisters the creator for the given type identifier. If the type identifier
96 <         * was previously registered, the function returns true.
97 <         * @return truethe type identifier was previously registered and the creator is removed,
98 <         * otherwise return false
99 <         * @id the identification of the concrete object
100 <         */
101 <        bool unregisterLattice(const std::string& id);
102 <        /**
103 <         * Looks up the type identifier in the internal map. If it is found, it invokes the
104 <         * corresponding creator for the type identifier and returns its result.
105 <         * @return a pointer of the concrete object, return NULL if no creator is registed for
106 <         * creating this concrete object
107 <         * @param id the identification of the concrete object
108 <         */
109 <        Lattice* createLattice(const std::string& id);
94 >    /**
95 >     * Unregisters the creator for the given type identifier. If the type identifier
96 >     * was previously registered, the function returns true.
97 >     * @return truethe type identifier was previously registered and the creator is removed,
98 >     * otherwise return false
99 >     * @id the identification of the concrete object
100 >     */
101 >    bool unregisterLattice(const std::string& id);
102 >    /**
103 >     * Looks up the type identifier in the internal map. If it is found, it invokes the
104 >     * corresponding creator for the type identifier and returns its result.
105 >     * @return a pointer of the concrete object, return NULL if no creator is registed for
106 >     * creating this concrete object
107 >     * @param id the identification of the concrete object
108 >     */
109 >    Lattice* createLattice(const std::string& id);
110  
111 <        /**
112 <         *  Returns all of the registed  type identifiers
113 <         * @return all of the registed  type identifiers
114 <         */
115 <        IdentVectorType getIdents();
111 >    /**
112 >     *  Returns all of the registed  type identifiers
113 >     * @return all of the registed  type identifiers
114 >     */
115 >    IdentVectorType getIdents();
116          
117 <    private:
118 <        LatticeFactory() {}
117 >  private:
118 >    LatticeFactory() {}
119          
120 <        static LatticeFactory* instance_;
121 <        CreatorMapType creatorMap_;
122 < };
120 >    static LatticeFactory* instance_;
121 >    CreatorMapType creatorMap_;
122 >  };
123  
124 < /** write out all of the type identifiers to an output stream */
125 < std::ostream& operator <<(std::ostream& o, LatticeFactory& factory);
124 >  /** write out all of the type identifiers to an output stream */
125 >  std::ostream& operator <<(std::ostream& o, LatticeFactory& factory);
126  
127 < }//namespace oopse
127 > }//namespace OpenMD
128   #endif //USETHEFORCE_FORCEFIELDFACTORY_HPP

Diff Legend

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