ViewVC Help

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

root/OpenMD/branches/development/src/utils/PropertyMap.hpp

Comparing:
trunk/src/utils/PropertyMap.hpp (file contents), Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
branches/development/src/utils/PropertyMap.hpp (file contents), Revision 1665 by gezelter, Tue Nov 22 20:38:56 2011 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 56 | Line 57
57
58		#include <utils/GenericData.hpp>
59
60	<	namespace oopse{
60	>	namespace OpenMD{
61
62	<	/**
63	<	* @class PropertyMap
64	<	* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
65	<	*/
66	<	class PropertyMap{
67	<	public:
62	>	/**
63	>	* @class PropertyMap
64	>	* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
65	>	*/
66	>	class PropertyMap{
67	>	public:
68
69	<	/** trivial constructor */
70	<	PropertyMap() {}
69	>	/** trivial constructor */
70	>	PropertyMap() {}
71
72	<	/**
73	<	* Virtual Destructor responsible for deleting all of the generc data in PropertyMap
74	<	*/
75	<	virtual ~PropertyMap();
72	>	/**
73	>	* Virtual Destructor responsible for deleting all of the generc data in PropertyMap
74	>	*/
75	>	virtual ~PropertyMap();
76
77	<	/**
78	<	* Adds property into property map
79	<	*
80	<	* @param genData GenericData to be added into PropertyMap
81	<	*
82	<	* @see #removeProperty
83	<	* @see #clearProperties
84	<	*/
85	<	void addProperty(GenericData* genData);
77	>	/**
78	>	* Adds property into property map
79	>	*
80	>	* @param genData GenericData to be added into PropertyMap
81	>	*
82	>	* @see #removeProperty
83	>	* @see #clearProperties
84	>	*/
85	>	void addProperty(GenericData* genData);
86
87	<	/**
88	<	* Removes property from PropertyMap by name
89	<	*
90	<	* @param propName the name of property to be removed
91	<	*
92	<	* @see #addProperty
93	<	* @see #clearProperties
94	<	*/
95	<	bool removeProperty(const std::string& propName);
87	>	/**
88	>	* Removes property from PropertyMap by name
89	>	*
90	>	* @param propName the name of property to be removed
91	>	*
92	>	* @see #addProperty
93	>	* @see #clearProperties
94	>	*/
95	>	bool removeProperty(const std::string& propName);
96
97	<	/**
98	<	* clear all of the properties
99	<	*
100	<	* @see #addProperty
101	<	* @see #removeProperty
102	<	*/
103	<	void clearProperties();
97	>	/**
98	>	* clear all of the properties
99	>	*
100	>	* @see #addProperty
101	>	* @see #removeProperty
102	>	*/
103	>	void clearProperties();
104
105	<	/**
106	<	* Returns all names of properties
107	<	*
108	<	* @return all names of properties
109	<	*/
110	<	std::vector<std::string> getPropertyNames();
105	>	/**
106	>	* Returns all names of properties
107	>	*
108	>	* @return all names of properties
109	>	*/
110	>	std::vector<std::string> getPropertyNames();
111
112	<	/**
113	<	* Returns all of the properties in PropertyMap
114	<	*
115	<	* @return all of the properties in PropertyMap
116	<	*
117	<	* @see #getPropertyByName
118	<	*/
119	<	std::vector<GenericData*> getProperties();
112	>	/**
113	>	* Returns all of the properties in PropertyMap
114	>	*
115	>	* @return all of the properties in PropertyMap
116	>	*
117	>	* @see #getPropertyByName
118	>	*/
119	>	std::vector<GenericData*> getProperties();
120
121	<	/**
122	<	* Returns property
123	<	*
124	<	* @param propName name of property
125	<	*
126	<	* @return a pointer point to property with propName. If no property named propName
127	<	* exists, return NULL
128	<	*
129	<	* @see #getProperties
130	<	*/
131	<	GenericData* getPropertyByName(const std::string& propName);
132	<	//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName);
121	>	/**
122	>	* Returns property
123	>	*
124	>	* @param propName name of property
125	>	*
126	>	* @return a pointer point to property with propName. If no property named propName
127	>	* exists, return NULL
128	>	*
129	>	* @see #getProperties
130	>	*/
131	>	GenericData* getPropertyByName(const std::string& propName);
132	>	//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName);
133
134	<	protected:
135	<	std::map<std::string, GenericData*> propMap_;
134	>	protected:
135	>	std::map<std::string, GenericData*> propMap_;
136
137	<	private:
137	>	private:
138
139	<	/** prevent copy constructing */
140	<	PropertyMap(const PropertyMap&);
139	>	/** prevent copy constructing */
140	>	PropertyMap(const PropertyMap&);
141
142	<	/** prevent copy assignment */
143	<	PropertyMap& operator=(const PropertyMap&);
144	<	};
142	>	/** prevent copy assignment */
143	>	PropertyMap& operator=(const PropertyMap&);
144	>	};
145
146	<	}// namespace oopse
146	>	}// namespace OpenMD
147
148		#endif //UTIL_PROPERTYMAP_HPP

Comparing:
trunk/src/utils/PropertyMap.hpp (property svn:keywords), Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
branches/development/src/utils/PropertyMap.hpp (property svn:keywords), Revision 1665 by gezelter, Tue Nov 22 20:38:56 2011 UTC

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

Diff Legend

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