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 |
54 |
|
#include <iostream> |
55 |
|
namespace oopse { |
56 |
|
|
57 |
< |
//forward declaration |
58 |
< |
class Integrator; |
59 |
< |
class IntegratorCreator; |
60 |
< |
class SimInfo; |
61 |
< |
/** |
62 |
< |
* @class IntegratorFactory IntegratorFactory.hpp "UseTheForce/IntegratorFactory.hpp" |
63 |
< |
* Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator. |
64 |
< |
*/ |
65 |
< |
class IntegratorFactory { |
66 |
< |
public: |
57 |
> |
//forward declaration |
58 |
> |
class Integrator; |
59 |
> |
class IntegratorCreator; |
60 |
> |
class SimInfo; |
61 |
> |
/** |
62 |
> |
* @class IntegratorFactory IntegratorFactory.hpp "UseTheForce/IntegratorFactory.hpp" |
63 |
> |
* Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator. |
64 |
> |
*/ |
65 |
> |
class IntegratorFactory { |
66 |
> |
public: |
67 |
|
|
68 |
< |
typedef std::map<std::string, IntegratorCreator*> CreatorMapType; |
69 |
< |
typedef std::vector<std::string> IdentVectorType; |
70 |
< |
typedef std::vector<std::string>::iterator IdentVectorIterator; |
68 |
> |
typedef std::map<std::string, IntegratorCreator*> CreatorMapType; |
69 |
> |
typedef std::vector<std::string> IdentVectorType; |
70 |
> |
typedef std::vector<std::string>::iterator IdentVectorIterator; |
71 |
|
|
72 |
< |
~IntegratorFactory(); |
72 |
> |
~IntegratorFactory(); |
73 |
|
|
74 |
< |
/** |
75 |
< |
* Returns an instance of Integrator factory |
76 |
< |
* @return an instance of Integrator factory |
77 |
< |
*/ |
78 |
< |
static IntegratorFactory* getInstance() { |
74 |
> |
/** |
75 |
> |
* Returns an instance of Integrator factory |
76 |
> |
* @return an instance of Integrator factory |
77 |
> |
*/ |
78 |
> |
static IntegratorFactory* getInstance() { |
79 |
|
|
80 |
< |
if (instance_ == NULL) { |
81 |
< |
instance_ = new IntegratorFactory(); |
82 |
< |
} |
83 |
< |
return instance_; |
80 |
> |
if (instance_ == NULL) { |
81 |
> |
instance_ = new IntegratorFactory(); |
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 registerIntegrator(IntegratorCreator* creator); |
87 |
> |
/** |
88 |
> |
* Registers a creator with a type identifier |
89 |
> |
* @return true if registration is successful, otherwise return false |
90 |
> |
* @id the identification of the concrete object |
91 |
> |
* @creator the object responsible to create the concrete object |
92 |
> |
*/ |
93 |
> |
bool registerIntegrator(IntegratorCreator* 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 unregisterIntegrator(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 |
< |
Integrator* createIntegrator(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 unregisterIntegrator(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 |
> |
Integrator* createIntegrator(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 |
< |
IntegratorFactory() {} |
120 |
< |
static IntegratorFactory* instance_; |
121 |
< |
CreatorMapType creatorMap_; |
122 |
< |
}; |
118 |
> |
private: |
119 |
> |
IntegratorFactory() {} |
120 |
> |
static IntegratorFactory* 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, IntegratorFactory& factory); |
124 |
> |
/** write out all of the type identifiers to an output stream */ |
125 |
> |
std::ostream& operator <<(std::ostream& o, IntegratorFactory& factory); |
126 |
|
|
127 |
|
}//namespace oopse |
128 |
|
#endif //INTEGRATORS_INTEGRATORFACTORY_HPP |