src/utils/PropertyMap.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file PropertyMap.hpp
 * @author tlin
 * @date 09/21/2004
 * @version 1.0
 */
 
#ifndef UTIL_PROPERTYMAP_HPP
#define UTIL_PROPERTYMAP_HPP

#include <map>
#include <string>
#include <vector>

#include <utils/GenericData.hpp>

namespace OpenMD{

  /**
   * @class PropertyMap
   * PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
   */
  class PropertyMap{
  public:

    /** trivial constructor */
    PropertyMap() {}

    /**
     * Virtual Destructor responsible for deleting all of the generc data in PropertyMap
     */
    virtual ~PropertyMap();

    /**
     * Adds property into property map
     *
     * @param genData GenericData to be added into PropertyMap
     *
     * @see #removeProperty
     * @see #clearProperties
     */
    void addProperty(GenericData* genData);

    /**
     * Removes property from PropertyMap by name
     *
     * @param propName the name of property to be removed
     *
     * @see #addProperty
     * @see #clearProperties
     */
    bool removeProperty(const std::string& propName);

    /**
     * clear all of the properties
     *
     * @see #addProperty
     * @see #removeProperty
     */
    void clearProperties();

    /**
     * Returns all names of properties
     *
     * @return all names of properties
     */
    std::vector<std::string> getPropertyNames();

    /**
     * Returns all of the properties in PropertyMap
     *
     * @return all of the properties in PropertyMap
     *
     * @see #getPropertyByName
     */      
    std::vector<GenericData*> getProperties();

    /**
     * Checks if property is in this PropertyMap
     *
     * @param propName name of property
     *
     * @return boolean
     *
     * @see #getProperties, #getPropertyByName
     */      
    bool hasProperty(const std::string& propName);

    /**
     * Returns property 
     *
     * @param propName name of property
     *
     * @return a pointer point to property with propName. If no property named propName
     * exists, return NULL
     *
     * @see #getProperties
     */      
    GenericData* getPropertyByName(const std::string& propName);
    //template<typename T = GenericData*> T getPropertyByName(std:std::string& propName);

  protected:
    std::map<std::string, GenericData*> propMap_;

  private:

    /** prevent copy constructing */
    PropertyMap(const PropertyMap&);

    /** prevent copy assignment */
    PropertyMap& operator=(const PropertyMap&);
  };

}// namespace OpenMD

#endif //UTIL_PROPERTYMAP_HPP
Revision:	1808
Committed:	Mon Oct 22 20:42:10 2012 UTC (12 years, 6 months ago) by gezelter
File size:	4729 byte(s)
Log Message:	A bug fix in the electric field for the new electrostatic code. Also comment fixes for Doxygen
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
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.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
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	/**
44	* @file PropertyMap.hpp
45	* @author tlin
46	* @date 09/21/2004
47	* @version 1.0
48	*/
49
50	#ifndef UTIL_PROPERTYMAP_HPP
51	#define UTIL_PROPERTYMAP_HPP
52
53	#include <map>
54	#include <string>
55	#include <vector>
56
57	#include <utils/GenericData.hpp>
58
59	namespace OpenMD{
60
61	/**
62	* @class PropertyMap
63	* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
64	*/
65	class PropertyMap{
66	public:
67
68	/** trivial constructor */
69	PropertyMap() {}
70
71	/**
72	* Virtual Destructor responsible for deleting all of the generc data in PropertyMap
73	*/
74	virtual ~PropertyMap();
75
76	/**
77	* Adds property into property map
78	*
79	* @param genData GenericData to be added into PropertyMap
80	*
81	* @see #removeProperty
82	* @see #clearProperties
83	*/
84	void addProperty(GenericData* genData);
85
86	/**
87	* Removes property from PropertyMap by name
88	*
89	* @param propName the name of property to be removed
90	*
91	* @see #addProperty
92	* @see #clearProperties
93	*/
94	bool removeProperty(const std::string& propName);
95
96	/**
97	* clear all of the properties
98	*
99	* @see #addProperty
100	* @see #removeProperty
101	*/
102	void clearProperties();
103
104	/**
105	* Returns all names of properties
106	*
107	* @return all names of properties
108	*/
109	std::vector<std::string> getPropertyNames();
110
111	/**
112	* Returns all of the properties in PropertyMap
113	*
114	* @return all of the properties in PropertyMap
115	*
116	* @see #getPropertyByName
117	*/
118	std::vector<GenericData*> getProperties();
119
120	/**
121	* Checks if property is in this PropertyMap
122	*
123	* @param propName name of property
124	*
125	* @return boolean
126	*
127	* @see #getProperties, #getPropertyByName
128	*/
129	bool hasProperty(const std::string& propName);
130
131	/**
132	* Returns property
133	*
134	* @param propName name of property
135	*
136	* @return a pointer point to property with propName. If no property named propName
137	* exists, return NULL
138	*
139	* @see #getProperties
140	*/
141	GenericData* getPropertyByName(const std::string& propName);
142	//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName);
143
144	protected:
145	std::map<std::string, GenericData*> propMap_;
146
147	private:
148
149	/** prevent copy constructing */
150	PropertyMap(const PropertyMap&);
151
152	/** prevent copy assignment */
153	PropertyMap& operator=(const PropertyMap&);
154	};
155
156	}// namespace OpenMD
157
158	#endif //UTIL_PROPERTYMAP_HPP