ViewVC Help

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

root/OpenMD/branches/development/src/lattice/LatticeFactory.hpp

Comparing:
trunk/src/lattice/LatticeFactory.hpp (file contents), Revision 484 by tim, Tue Apr 12 21:58:09 2005 UTC vs.
branches/development/src/lattice/LatticeFactory.hpp (file contents), Revision 1808 by gezelter, Mon Oct 22 20:42:10 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 Lattice;
60	<	class LatticeCreator;
61	<	/**
62	<	* @class LatticeFactory LatticeFactory.hpp "UseTheForce/LatticeFactory.hpp"
63	<	* Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
64	<	*/
65	<	class LatticeFactory {
66	<	public:
58	>	//forward declaration
59	>	class Lattice;
60	>	class LatticeCreator;
61	>	/**
62	>	* @class LatticeFactory
63	>	* Factory pattern and Singleton Pattern are used to define an interface for creating an Lattice.
64	>	*/
65	>	class LatticeFactory {
66	>	public:
67
68	<	typedef std::map<std::string, LatticeCreator*> CreatorMapType;
69	<	typedef std::vector<std::string> IdentVectorType;
70	<	typedef std::vector<std::string>::iterator IdentVectorIterator;
68	>	typedef std::map<std::string, LatticeCreator*> CreatorMapType;
69	>	typedef std::vector<std::string> IdentVectorType;
70	>	typedef std::vector<std::string>::iterator IdentVectorIterator;
71
72	<	~LatticeFactory();
72	>	~LatticeFactory();
73
74	<	/**
75	<	* Returns an instance of Lattice factory
76	<	* @return an instance of Lattice factory
77	<	*/
78	<	static LatticeFactory* getInstance() {
74	>	/**
75	>	* Returns an instance of Lattice factory
76	>	* @return an instance of Lattice factory
77	>	*/
78	>	static LatticeFactory* getInstance() {
79
80	<	if (instance_ == NULL) {
81	<	instance_ = new LatticeFactory();
82	<	}
83	<	return instance_;
80	>	if (instance_ == NULL) {
81	>	instance_ = new LatticeFactory();
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	<	*/
92	<	bool registerLattice(LatticeCreator* creator);
87	>	/**
88	>	* Registers a creator with a type identifier
89	>	* @return true if registration is succeed, otherwise return false
90	>	* @param 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);
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	>	* @param 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	<	/**
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	<	LatticeFactory() {}
117	>	private:
118	>	LatticeFactory() {}
119
120	<	static LatticeFactory* instance_;
121	<	CreatorMapType creatorMap_;
122	<	};
120	>	static LatticeFactory* 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, LatticeFactory& factory);
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
127	>	}//namespace OpenMD
128		#endif //USETHEFORCE_FORCEFIELDFACTORY_HPP

Comparing:
trunk/src/lattice/LatticeFactory.hpp (property svn:keywords), Revision 484 by tim, Tue Apr 12 21:58:09 2005 UTC vs.
branches/development/src/lattice/LatticeFactory.hpp (property svn:keywords), Revision 1808 by gezelter, Mon Oct 22 20:42:10 2012 UTC

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

Diff Legend

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