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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @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 oopse{

  /**
   * @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 oopse

#endif //UTIL_PROPERTYMAP_HPP
Revision:	507
Committed:	Fri Apr 15 22:04:00 2005 UTC (20 years, 6 months ago) by gezelter
File size:	4382 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	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. 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
19	* notice, this list of conditions and the following disclaimer.
20	*
21	* 3. Redistributions in binary form must reproduce the above copyright
22	* notice, this list of conditions and the following disclaimer in the
23	* documentation and/or other materials provided with the
24	* distribution.
25	*
26	* This software is provided "AS IS," without a warranty of any
27	* kind. All express or implied conditions, representations and
28	* warranties, including any implied warranty of merchantability,
29	* fitness for a particular purpose or non-infringement, are hereby
30	* excluded. The University of Notre Dame and its licensors shall not
31	* be liable for any damages suffered by licensee as a result of
32	* using, modifying or distributing the software or its
33	* derivatives. In no event will the University of Notre Dame or its
34	* licensors be liable for any lost revenue, profit or data, or for
35	* direct, indirect, special, consequential, incidental or punitive
36	* damages, however caused and regardless of the theory of liability,
37	* arising out of the use of or inability to use software, even if the
38	* University of Notre Dame has been advised of the possibility of
39	* such damages.
40	*/
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	#include <utils/GenericData.hpp>
58
59	namespace oopse{
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	* 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
133	protected:
134	std::map<std::string, GenericData*> propMap_;
135
136	private:
137
138	/** prevent copy constructing */
139	PropertyMap(const PropertyMap&);
140
141	/** prevent copy assignment */
142	PropertyMap& operator=(const PropertyMap&);
143	};
144
145	}// namespace oopse
146
147	#endif //UTIL_PROPERTYMAP_HPP