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 2204 by gezelter, Fri Apr 15 22:04:00 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 "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:
66                  
67 <        typedef std::map<std::string, ForceFieldCreator*> CreatorMapType;
68 <        typedef std::vector<std::string> IdentVectorType;
69 <        typedef std::vector<std::string>::iterator IdentVectorIterator;
67 >    typedef std::map<std::string, ForceFieldCreator*> CreatorMapType;
68 >    typedef std::vector<std::string> IdentVectorType;
69 >    typedef std::vector<std::string>::iterator IdentVectorIterator;
70  
71 <        ~ForceFieldFactory();
71 >    ~ForceFieldFactory();
72                      
73 <        /**
74 <         * Returns an instance of ForceField factory
75 <         * @return an instance of ForceField factory
76 <         */        
77 <        static ForceFieldFactory* getInstance() {
73 >    /**
74 >     * Returns an instance of ForceField factory
75 >     * @return an instance of ForceField factory
76 >     */        
77 >    static ForceFieldFactory* getInstance() {
78  
79 <            if (instance_ == NULL) {
80 <                instance_ = new ForceFieldFactory();
81 <            }
82 <            return instance_;
79 >      if (instance_ == NULL) {
80 >        instance_ = new ForceFieldFactory();
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 registerForceField(ForceFieldCreator* 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 registerForceField(ForceFieldCreator* 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 unregisterForceField(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 <        ForceField* createForceField(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 unregisterForceField(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 >    ForceField* createForceField(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 <        ForceFieldFactory() {}
117 >  private:
118 >    ForceFieldFactory() {}
119          
120 <        static ForceFieldFactory* instance_;
121 <        CreatorMapType creatorMap_;
122 < };
120 >    static ForceFieldFactory* 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, ForceFieldFactory& factory);
124 >  /** write out all of the type identifiers to an output stream */
125 >  std::ostream& operator <<(std::ostream& o, ForceFieldFactory& factory);
126  
127   }//namespace oopse
128   #endif //USETHEFORCE_FORCEFIELDFACTORY_HPP

Diff Legend

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