ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/OpenMD/trunk/src/integrators/IntegratorFactory.hpp

Comparing trunk/src/integrators/IntegratorFactory.hpp (file contents):
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 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]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
40	+	* [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41		*/
42
43		/**
#	Line 52 | Line 53
53		#include <string>
54		#include <vector>
55		#include <iostream>
56	<	namespace oopse {
56	>	namespace OpenMD {
57
58	<	//forward declaration
59	<	class Integrator;
60	<	class IntegratorCreator;
61	<	class SimInfo;
62	<	/**
63	<	* @class IntegratorFactory IntegratorFactory.hpp "UseTheForce/IntegratorFactory.hpp"
64	<	* Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator.
65	<	*/
66	<	class IntegratorFactory {
67	<	public:
58	>	//forward declaration
59	>	class Integrator;
60	>	class IntegratorCreator;
61	>	class SimInfo;
62	>	/**
63	>	* @class IntegratorFactory
64	>	* Factory pattern and Singleton Pattern are used to define an interface for creating an Integrator.
65	>	*/
66	>	class IntegratorFactory {
67	>	public:
68
69	<	typedef std::map<std::string, IntegratorCreator*> CreatorMapType;
70	<	typedef std::vector<std::string> IdentVectorType;
71	<	typedef std::vector<std::string>::iterator IdentVectorIterator;
69	>	typedef std::map<std::string, IntegratorCreator*> CreatorMapType;
70	>	typedef std::vector<std::string> IdentVectorType;
71	>	typedef std::vector<std::string>::iterator IdentVectorIterator;
72
73	<	~IntegratorFactory();
73	>	~IntegratorFactory();
74
75	<	/**
76	<	* Returns an instance of Integrator factory
77	<	* @return an instance of Integrator factory
78	<	*/
79	<	static IntegratorFactory* getInstance() {
75	>	/**
76	>	* Returns an instance of Integrator factory
77	>	* @return an instance of Integrator factory
78	>	*/
79	>	static IntegratorFactory* getInstance() {
80
81	<	if (instance_ == NULL) {
82	<	instance_ = new IntegratorFactory();
83	<	}
84	<	return instance_;
81	>	if (instance_ == NULL) {
82	>	instance_ = new IntegratorFactory();
83	>	}
84	>	return instance_;
85
86	<	}
86	>	}
87
88	<	/**
89	<	* Registers a creator with a type identifier
90	<	* @return true if registration is succeed, otherwise return false
91	<	* @id the identification of the concrete object
92	<	* @creator the object responsible to create the concrete object
93	<	*/
94	<	bool registerIntegrator(IntegratorCreator* creator);
88	>	/**
89	>	* Registers a creator with a type identifier
90	>	* @return true if registration is successful, otherwise return false
91	>	* @id the identification of the concrete object
92	>	* @creator the object responsible to create the concrete object
93	>	*/
94	>	bool registerIntegrator(IntegratorCreator* creator);
95
96	<	/**
97	<	* Unregisters the creator for the given type identifier. If the type identifier
98	<	* was previously registered, the function returns true.
99	<	* @return truethe type identifier was previously registered and the creator is removed,
100	<	* otherwise return false
101	<	* @id the identification of the concrete object
102	<	*/
103	<	bool unregisterIntegrator(const std::string& id);
104	<	/**
105	<	* Looks up the type identifier in the internal map. If it is found, it invokes the
106	<	* corresponding creator for the type identifier and returns its result.
107	<	* @return a pointer of the concrete object, return NULL if no creator is registed for
108	<	* creating this concrete object
109	<	* @param id the identification of the concrete object
110	<	*/
111	<	Integrator* createIntegrator(const std::string& id, SimInfo* info);
96	>	/**
97	>	* Unregisters the creator for the given type identifier. If the type identifier
98	>	* was previously registered, the function returns true.
99	>	* @return truethe type identifier was previously registered and the creator is removed,
100	>	* otherwise return false
101	>	* @id the identification of the concrete object
102	>	*/
103	>	bool unregisterIntegrator(const std::string& id);
104	>	/**
105	>	* Looks up the type identifier in the internal map. If it is found, it invokes the
106	>	* corresponding creator for the type identifier and returns its result.
107	>	* @return a pointer of the concrete object, return NULL if no creator is registed for
108	>	* creating this concrete object
109	>	* @param id the identification of the concrete object
110	>	*/
111	>	Integrator* createIntegrator(const std::string& id, SimInfo* info);
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	<	IntegratorFactory() {}
121	<	static IntegratorFactory* instance_;
122	<	CreatorMapType creatorMap_;
123	<	};
119	>	private:
120	>	IntegratorFactory() {}
121	>	static IntegratorFactory* instance_;
122	>	CreatorMapType creatorMap_;
123	>	};
124
125	<	/** write out all of the type identifiers to an output stream */
126	<	std::ostream& operator <<(std::ostream& o, IntegratorFactory& factory);
125	>	/** write out all of the type identifiers to an output stream */
126	>	std::ostream& operator <<(std::ostream& o, IntegratorFactory& factory);
127
128	<	}//namespace oopse
128	>	}//namespace OpenMD
129		#endif //INTEGRATORS_INTEGRATORFACTORY_HPP
130

Comparing trunk/src/integrators/IntegratorFactory.hpp (property svn:keywords):
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 UTC

#	Line 0 | Line 1
1	+	Author Id Revision Date

Diff Legend

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