ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/utils/PropertyMap.hpp
(Generate patch)

Comparing trunk/src/utils/PropertyMap.hpp (file contents):
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC vs.
Revision 1390 by gezelter, Wed Nov 25 20:02:06 2009 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]  Vardeman & Gezelter, in progress (2009).                        
40   */
41  
42   /**
# Line 56 | Line 56
56  
57   #include <utils/GenericData.hpp>
58  
59 < namespace oopse{
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:
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() {}
68 >    /** trivial constructor */
69 >    PropertyMap() {}
70  
71 <            /**
72 <            * Virtual Destructor responsible for deleting all of the generc data in PropertyMap
73 <            */
74 <            virtual ~PropertyMap();
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);
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);
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();
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();
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();
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);
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_;
133 >  protected:
134 >    std::map<std::string, GenericData*> propMap_;
135  
136 <        private:
136 >  private:
137  
138 <            /** prevent copy constructing */
139 <            PropertyMap(const PropertyMap&);
138 >    /** prevent copy constructing */
139 >    PropertyMap(const PropertyMap&);
140  
141 <            /** prevent copy assignment */
142 <            PropertyMap& operator=(const PropertyMap&);
143 <    };
141 >    /** prevent copy assignment */
142 >    PropertyMap& operator=(const PropertyMap&);
143 >  };
144  
145 < }// namespace oopse
145 > }// namespace OpenMD
146  
147   #endif //UTIL_PROPERTYMAP_HPP

Diff Legend

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