ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-4/src/UseTheForce/ForceFieldFactory.hpp
(Generate patch)

Comparing trunk/OOPSE-4/src/UseTheForce/ForceFieldFactory.hpp (file contents):
Revision 1930 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 2211 by chrisfen, Thu Apr 21 14:12:19 2005 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 54 | Line 54 | namespace oopse {
54   #include <iostream>
55   namespace oopse {
56  
57 < //forward declaration
58 < class ForceField;
59 < class ForceFieldCreator;
60 < /**
61 < * @class ForceFieldFactory ForceFieldFactory.hpp "UseTheForce/ForceFieldFactory.hpp"
62 < * Factory pattern and Singleton Pattern are used to define an interface for creating an ForceField.
63 < */
64 < class ForceFieldFactory {
65 <    public:
57 >  //forward declaration
58 >  class ForceField;
59 >  class ForceFieldCreator;
60 >  /**
61 >   * @class ForceFieldFactory ForceFieldFactory.hpp
62 >   * "UseTheForce/ForceFieldFactory.hpp" Factory pattern and Singleton Pattern
63 >   * are used to define an interface for creating an ForceField.
64 >   */
65 >  class ForceFieldFactory {
66 >  public:
67                  
68 <        typedef std::map<std::string, ForceFieldCreator*> CreatorMapType;
69 <        typedef std::vector<std::string> IdentVectorType;
70 <        typedef std::vector<std::string>::iterator IdentVectorIterator;
68 >    typedef std::map<std::string, ForceFieldCreator*> CreatorMapType;
69 >    typedef std::vector<std::string> IdentVectorType;
70 >    typedef std::vector<std::string>::iterator IdentVectorIterator;
71  
72 <        ~ForceFieldFactory();
72 >    ~ForceFieldFactory();
73                      
74 <        /**
75 <         * Returns an instance of ForceField factory
76 <         * @return an instance of ForceField factory
77 <         */        
78 <        static ForceFieldFactory* getInstance() {
74 >    /**
75 >     * Returns an instance of ForceField factory
76 >     * @return an instance of ForceField factory
77 >     */        
78 >    static ForceFieldFactory* getInstance() {
79  
80 <            if (instance_ == NULL) {
81 <                instance_ = new ForceFieldFactory();
82 <            }
83 <            return instance_;
80 >      if (instance_ == NULL) {
81 >        instance_ = new ForceFieldFactory();
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 registerForceField(ForceFieldCreator* 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 registerForceField(ForceFieldCreator* 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 unregisterForceField(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 <        ForceField* createForceField(const std::string& id);
95 >    /**
96 >     * Unregisters the creator for the given type identifier. If the type
97 >     * identifier was previously registered, the function returns true.
98 >     * @return truethe type identifier was previously registered and the creator
99 >     * is removed, otherwise return false
100 >     * @id the identification of the concrete object
101 >     */
102 >    bool unregisterForceField(const std::string& id);
103 >    /**
104 >     * Looks up the type identifier in the internal map. If it is found, it
105 >     * invokes the corresponding creator for the type identifier and returns
106 >     * its result.
107 >     * @return a pointer of the concrete object, return NULL if no creator is
108 >     * registed for creating this concrete object
109 >     * @param id the identification of the concrete object
110 >     */
111 >    ForceField* createForceField(const std::string& id);
112  
113 <        /**
114 <         *  Returns all of the registed  type identifiers
115 <         * @return all of the registed  type identifiers
116 <         */
117 <        IdentVectorType getIdents();
113 >    /**
114 >     *  Returns all of the registed  type identifiers
115 >     * @return all of the registed  type identifiers
116 >     */
117 >    IdentVectorType getIdents();
118          
119 <    private:
120 <        ForceFieldFactory() {}
119 >  private:
120 >    ForceFieldFactory() {}
121          
122 <        static ForceFieldFactory* instance_;
123 <        CreatorMapType creatorMap_;
124 < };
122 >    static ForceFieldFactory* instance_;
123 >    CreatorMapType creatorMap_;
124 >  };
125  
126 < /** write out all of the type identifiers to an output stream */
127 < std::ostream& operator <<(std::ostream& o, ForceFieldFactory& factory);
126 >  /** write out all of the type identifiers to an output stream */
127 >  std::ostream& operator <<(std::ostream& o, ForceFieldFactory& factory);
128  
129   }//namespace oopse
130   #endif //USETHEFORCE_FORCEFIELDFACTORY_HPP

Diff Legend

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