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
 * @time 9:20am
 * @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();

    /**
     * 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:	1665
Committed:	Tue Nov 22 20:38:56 2011 UTC (13 years, 5 months ago) by gezelter
File size:	4491 byte(s)
Log Message:	updated copyright notices
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	73	*
4	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* 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	gezelter	1390	*
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	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	tim	73	*/
42
43			/**
44			* @file PropertyMap.hpp
45			* @author tlin
46			* @date 09/21/2004
47			* @time 9:20am
48			* @version 1.0
49			*/
50
51			#ifndef UTIL_PROPERTYMAP_HPP
52			#define UTIL_PROPERTYMAP_HPP
53
54			#include <map>
55			#include <string>
56			#include <vector>
57
58	tim	129	#include <utils/GenericData.hpp>
59	tim	73
60	gezelter	1390	namespace OpenMD{
61	tim	73
62	gezelter	507	/**
63			* @class PropertyMap
64			* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
65			*/
66			class PropertyMap{
67			public:
68	tim	73
69	gezelter	507	/** trivial constructor */
70			PropertyMap() {}
71	tim	73
72	gezelter	507	/**
73			* Virtual Destructor responsible for deleting all of the generc data in PropertyMap
74			*/
75			virtual ~PropertyMap();
76	tim	73
77	gezelter	507	/**
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	tim	73
87	gezelter	507	/**
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	tim	73
97	gezelter	507	/**
98			* clear all of the properties
99			*
100			* @see #addProperty
101			* @see #removeProperty
102			*/
103			void clearProperties();
104	tim	73
105	gezelter	507	/**
106			* Returns all names of properties
107			*
108			* @return all names of properties
109			*/
110			std::vector<std::string> getPropertyNames();
111	tim	73
112	gezelter	507	/**
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	tim	73
121	gezelter	507	/**
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	tim	73
134	gezelter	507	protected:
135			std::map<std::string, GenericData*> propMap_;
136	tim	73
137	gezelter	507	private:
138	tim	73
139	gezelter	507	/** prevent copy constructing */
140			PropertyMap(const PropertyMap&);
141	tim	129
142	gezelter	507	/** prevent copy assignment */
143			PropertyMap& operator=(const PropertyMap&);
144			};
145	tim	129
146	gezelter	1390	}// namespace OpenMD
147	gezelter	246
148			#endif //UTIL_PROPERTYMAP_HPP