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 482 by gezelter, Tue Apr 12 21:27:33 2005 UTC vs.
Revision 484 by tim, Tue Apr 12 21:58:09 2005 UTC

# Line 39 | Line 39
39   * such damages.
40   */
41  
42 + /**
43 + * @file LatticeFactory.hpp
44 + * @author Teng Lin
45 + * @date 10/24/2004
46 + * @version 1.0
47 + */
48   #ifndef LATTICE_LATTICEFACTORY_HPP
49   #define LATTICE_LATTICEFACTORY_HPP
50 + #include <cassert>
51   #include <map>
52   #include <string>
53 <
53 > #include <vector>
54 > #include <iostream>
55   namespace oopse {
56  
57 < class BaseLatticeCreator;
58 < class BaseLattice;
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;
70  
71 < class LatticeFactory{
72 < public:
73 <        ~LatticeFactory();
71 >        ~LatticeFactory();
72 >                    
73 >        /**
74 >         * Returns an instance of Lattice factory
75 >         * @return an instance of Lattice factory
76 >         */        
77 >        static LatticeFactory* getInstance() {
78  
79 <        static LatticeFactory* getInstance();
79 >            if (instance_ == NULL) {
80 >                instance_ = new LatticeFactory();
81 >            }
82 >            return instance_;
83 >            
84 >        }
85  
86 <        bool registerCreator( BaseLatticeCreator*  latCreator );
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);
110  
111 <    bool hasLatticeCreator( const std::string& latticeType );
112 <
113 <    const  std::string toString();
114 <
115 <    BaseLattice* createLattice( const std::string& latticeType );
116 <    
117 < private:
118 <        LatticeFactory(){}
119 <    static LatticeFactory* instance;
120 <     std::map<std::string,  BaseLatticeCreator*> creatorMap;
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() {}
119 >        
120 >        static LatticeFactory* instance_;
121 >        CreatorMapType creatorMap_;
122   };
123  
124 < }
125 < #endif
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
128 > #endif //USETHEFORCE_FORCEFIELDFACTORY_HPP

Diff Legend

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