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

Comparing trunk/src/utils/PropertyMap.hpp (file contents):
Revision 73 by tim, Wed Oct 13 22:28:51 2004 UTC vs.
Revision 246 by gezelter, Wed Jan 12 22:41:40 2005 UTC

# Line 1 | Line 1
1 < /*
2 < * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
3 < *
4 < * Contact: oopse@oopse.org
5 < *
6 < * This program is free software; you can redistribute it and/or
7 < * modify it under the terms of the GNU Lesser General Public License
8 < * as published by the Free Software Foundation; either version 2.1
9 < * of the License, or (at your option) any later version.
10 < * All we ask is that proper credit is given for our work, which includes
11 < * - but is not limited to - adding the above copyright notice to the beginning
12 < * of your source code files, and to any copyright notice that you may distribute
13 < * with programs based on this work.
14 < *
15 < * This program is distributed in the hope that it will be useful,
16 < * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 < * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 < * GNU Lesser General Public License for more details.
19 < *
20 < * You should have received a copy of the GNU Lesser General Public License
21 < * along with this program; if not, write to the Free Software
22 < * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
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   /**
# Line 38 | Line 54
54   #include <string>
55   #include <vector>
56  
57 < #include <GenericData.hpp>
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:
51 <      
52 <      /** trivial constructor */
53 <      PropertyMap();
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 <      /**
69 <       * Virtual Destructor responsible for deleting all of the generc data in PropertyMap
57 <       */
58 <      virtual ~PropertyMap();
68 >            /** trivial constructor */
69 >            PropertyMap() {}
70  
71 <      /**
72 <       * Adds property into property map
73 <       *
74 <       * @param genData GenericData to be added into PropertyMap
64 <       *
65 <       * @see #removeProperty
66 <       * @see #clearProperties
67 <       */
68 <      void addProperty(GenericData* genData);
71 >            /**
72 >            * Virtual Destructor responsible for deleting all of the generc data in PropertyMap
73 >            */
74 >            virtual ~PropertyMap();
75  
76 <      /**
77 <       * Removes property from PropertyMap by name
78 <       *
79 <       * @param propName the name of property to be removed
80 <       *
81 <       * @see #addProperty
82 <       * @see #clearProperties
83 <       */
84 <      void removeProperty(std::string& propName);
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 <       * clear all of the properties
88 <       *
89 <       * @see #addProperty
90 <       * @see #removeProperty
91 <       */
92 <      void clearProperties();
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 <       * Returns all names of properties
98 <       *
99 <       * @return all names of properties
100 <       */
101 <      std::vector<std::string> getPropertyNames();
96 >            /**
97 >            * clear all of the properties
98 >            *
99 >            * @see #addProperty
100 >            * @see #removeProperty
101 >            */
102 >            void clearProperties();
103  
104 <      /**
105 <       * Returns all of the properties in PropertyMap
106 <       *
107 <       * @return all of the properties in PropertyMap
108 <       *
109 <       * @see #getPropertyByName
101 <       */      
102 <      std::vector<GenericData*> getProperties();
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 property
113 <       *
114 <       * @param propName name of property
115 <       *
116 <       * @return a pointer point to property with propName. If no property named propName
117 <       * exists, return NULL
118 <       *
112 <       * @see #getProperties
113 <       */      
114 <      GenericData* getPropertyByName(std:string& propName);
115 <      template<typename T = GenericData*> T getPropertyByName(std:string& propName);
116 <      
117 <    protected:
118 <      std::map<std::string, GenericData*> propMap_;
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 <    private:
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 <      /** prevent copy constructing */
134 <      PropertyMap(const PropertyMap&);
133 >            protected:
134 >            std::map<std::string, GenericData*> propMap_;
135  
136 <      /** prevent copy assignment */
126 <      PropertyMap& operator=(const PropertyMap&);
127 <  };
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 < #endif //UTIL_PROPERTYMAP_HPP
146 >
147 > #endif //UTIL_PROPERTYMAP_HPP

Diff Legend

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