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]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @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:	1465
Committed:	Fri Jul 9 23:08:25 2010 UTC (15 years, 3 months ago) by chuckv
File size:	4425 byte(s)
Log Message:	Creating busticated version of OpenMD
#	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			* [4] Vardeman & Gezelter, in progress (2009).
40	tim	73	*/
41
42			/**
43			* @file PropertyMap.hpp
44			* @author tlin
45			* @date 09/21/2004
46			* @time 9:20am
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	tim	129	#include <utils/GenericData.hpp>
58	tim	73
59	gezelter	1390	namespace OpenMD{
60	tim	73
61	gezelter	507	/**
62			* @class PropertyMap
63			* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData.
64			*/
65			class PropertyMap{
66			public:
67	tim	73
68	gezelter	507	/** trivial constructor */
69			PropertyMap() {}
70	tim	73
71	gezelter	507	/**
72			* Virtual Destructor responsible for deleting all of the generc data in PropertyMap
73			*/
74			virtual ~PropertyMap();
75	tim	73
76	gezelter	507	/**
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	tim	73
86	gezelter	507	/**
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	tim	73
96	gezelter	507	/**
97			* clear all of the properties
98			*
99			* @see #addProperty
100			* @see #removeProperty
101			*/
102			void clearProperties();
103	tim	73
104	gezelter	507	/**
105			* Returns all names of properties
106			*
107			* @return all names of properties
108			*/
109			std::vector<std::string> getPropertyNames();
110	tim	73
111	gezelter	507	/**
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	tim	73
120	gezelter	507	/**
121			* Returns property
122			*
123			* @param propName name of property
124			*
125			* @return a pointer point to property with propName. If no property named propName
126			* exists, return NULL
127			*
128			* @see #getProperties
129			*/
130			GenericData* getPropertyByName(const std::string& propName);
131			//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName);
132	tim	73
133	gezelter	507	protected:
134			std::map<std::string, GenericData*> propMap_;
135	tim	73
136	gezelter	507	private:
137	tim	73
138	gezelter	507	/** prevent copy constructing */
139			PropertyMap(const PropertyMap&);
140	tim	129
141	gezelter	507	/** prevent copy assignment */
142			PropertyMap& operator=(const PropertyMap&);
143			};
144	tim	129
145	gezelter	1390	}// namespace OpenMD
146	gezelter	246
147			#endif //UTIL_PROPERTYMAP_HPP