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

Comparing trunk/src/utils/GenericData.hpp (file contents):
Revision 132 by tim, Thu Oct 21 16:22:01 2004 UTC vs.
Revision 963 by tim, Wed May 17 21:51:42 2006 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.
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 <
41 >
42   /**
43   * @file GenericData.hpp
44   * @brief
# Line 38 | Line 54
54   #include <list>
55   #include <string>
56   #include <vector>
57 + #include "config.h"
58   namespace oopse{
59  
60 <    /**
61 <     * @ class GenericData GenericData.hpp "utils/GenericData.hpp"
62 <     * @brief Base class for generic data which is associated with an id
63 <     */
64 <    class GenericData{
65 <        public:
66 <            GenericData() :  id_("UndefinedGenericData"){}
60 >  /**
61 >   * @ class GenericData GenericData.hpp "utils/GenericData.hpp"
62 >   * @brief Base class for generic data which is associated with an id
63 >   */
64 >  class GenericData{
65 >  public:
66 >    GenericData() :  id_("UndefinedGenericData"){}
67  
68 <            GenericData(const std::string& id) {  setID(id);  }
68 >    GenericData(const std::string& id) {  setID(id);  }
69  
70 <            /** virtual destructor */
71 <            virtual ~GenericData() {}
70 >    /** virtual destructor */
71 >    virtual ~GenericData() {}
72  
73  
74 <            /**
75 <             *  Returns the id of this generic data
76 <             *
77 <             * @return the id of this generic data
78 <             *
79 <             * @see #setID
80 <             */
81 <            const std::string getID() const { return id_;  }
74 >    /**
75 >     *  Returns the id of this generic data
76 >     *
77 >     * @return the id of this generic data
78 >     *
79 >     * @see #setID
80 >     */
81 >    const std::string getID() const { return id_;  }
82  
83 <            /**
84 <             *  Sets the id of this generic data
85 <             *
86 <             * @param id the id to be set
87 <             *
88 <             * @see #getID
89 <             */
90 <            void setID(const std::string& id) { id_ = id;  }
83 >    /**
84 >     *  Sets the id of this generic data
85 >     *
86 >     * @param id the id to be set
87 >     *
88 >     * @see #getID
89 >     */
90 >    void setID(const std::string& id) { id_ = id;  }
91  
92              
93 <        private:
94 <            GenericData(const GenericData&);
95 <            GenericData& operator=(GenericData&);
96 <            std::string id_;
93 >  private:
94 >    GenericData(const GenericData&);
95 >    GenericData& operator=(GenericData&);
96 >    std::string id_;
97  
98 <    };
98 >  };
99  
100 <    /**
101 <     * @class SimpleTypeData
102 <     * @brief SimpleTypeData class is a POD  repository class
103 <     * @warning ElemDataType must be copy constructible, and copy assignable
104 <     */
105 <    template<typename ElemDataType> class SimpleTypeData : public GenericData{
100 >  /**
101 >   * @class SimpleTypeData
102 >   * @brief SimpleTypeData class is a POD  repository class
103 >   * @warning ElemDataType must be copy constructible, and copy assignable
104 >   */
105 >  template<typename ElemDataType> class SimpleTypeData : public GenericData{
106  
107 <        public:
108 <            SimpleTypeData() :  GenericData(), data_(ElemDataType()) {}
109 <            SimpleTypeData(const std::string& id) : GenericData(id), data_(ElemDataType()) {}
107 >  public:
108 >    SimpleTypeData() :  GenericData(), data_(ElemDataType()) {}
109 >    SimpleTypeData(const std::string& id) : GenericData(id), data_(ElemDataType()) {}
110 >    SimpleTypeData(const std::string&id , const ElemDataType& data) : GenericData(id), data_(data) {}
111 >    template<typename T>
112 >    SimpleTypeData(const SimpleTypeData<T>& s) {
113 >      data_ = s.getData();
114 >    }
115  
116 <            template<typename T>
117 <            SimpleTypeData(const SimpleTypeData<T>& s) {
118 <                data_ = s.getData();
97 <            }
98 <
99 <            SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<ElemDataType>& s) {
100 <                if (this == &s)
101 <                    return *this;
116 >    SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<ElemDataType>& s) {
117 >      if (this == &s)
118 >        return *this;
119                  
120 <                data_ = s.getData();
121 <                return *this;                
122 <            }
120 >      data_ = s.getData();
121 >      return *this;                
122 >    }
123              
124 <            template<typename T>
125 <            SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<T>& s) {                
126 <                data_ = s.getData();
127 <                return *this;
128 <            }
124 >    template<typename T>
125 >    SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<T>& s) {                
126 >      data_ = s.getData();
127 >      return *this;
128 >    }
129              
130 <            /** Returns POD data */    
131 <            const ElemDataType& getData() const {return data_;}
132 <            ElemDataType& getData()  {return data_;}
133 <            /**
134 <            * Sets POD data
135 <            * @data POD data to be set
136 <            */
137 <            void setData(const ElemDataType& data) { data_ = data;  }
130 >    /** Returns POD data */    
131 >    const ElemDataType& getData() const {return data_;}
132 >    ElemDataType& getData()  {return data_;}
133 >    /**
134 >     * Sets POD data
135 >     * @data POD data to be set
136 >     */
137 >    void setData(const ElemDataType& data) { data_ = data;  }
138  
139 <        private:
140 <            ElemDataType data_;
141 <    };
139 >  private:
140 >    ElemDataType data_;
141 >  };
142  
143 <    /** BoolGenericData is a generic data type contains a bool variable */
144 <    typedef SimpleTypeData<bool> BoolGenericData;
143 >  /** BoolGenericData is a generic data type contains a bool variable */
144 >  typedef SimpleTypeData<bool> BoolGenericData;
145  
146 <    /** IntGenericData is a generic data type contains an integer variable */
147 <    typedef SimpleTypeData<int> IntGenericData;
146 >  /** IntGenericData is a generic data type contains an integer variable */
147 >  typedef SimpleTypeData<int> IntGenericData;
148  
149 <    /** FloatGenericData is a generic data type contains a float variable */
150 <    typedef SimpleTypeData<float> FloatGenericData;
149 >  /** FloatGenericData is a generic data type contains a float variable */
150 >  typedef SimpleTypeData<float> FloatGenericData;
151  
152 <    /** DoubleGenericData is a generic data type contains a double variable */
153 <    typedef SimpleTypeData<double> DoubleGenericData;
152 >  /** DoubleGenericData is a generic data type contains a RealType variable */
153 >  typedef SimpleTypeData<RealType> DoubleGenericData;
154    
155 <    /**
156 <     * @typedef StringGenericData
157 <     * A generic data type contains a string variable
158 <     *
159 <     * @code
160 <     *   StringGenericData* s = new StringGenericData("MyStringGenericData");
161 <     *   PropertyMap propMap;
162 <     *   GenericData* gdata;
163 <     *
164 <     *   s->setData("OOPSE");
165 <     *   propMap->addProperty(s);
166 <     *  
167 <     *   gdata = propMap->getProperty("MyStringGenericData");
168 <     *   if (gdata != NULL){
169 <     *     s = dynamic_cast<StringGenericData*>(gdata);
170 <     *     if (s != NULL)
171 <     *       std::cout << s->getData() << std::endl;
172 <     *   }
173 <     *
174 <     * @endcode
175 <     */  
176 <    typedef SimpleTypeData<std::string> StringGenericData;
155 >  /**
156 >   * @typedef StringGenericData
157 >   * A generic data type contains a  std::string variable
158 >   *
159 >   * @code
160 >   *   StringGenericData* s = new StringGenericData("MyStringGenericData");
161 >   *   PropertyMap propMap;
162 >   *   GenericData* gdata;
163 >   *
164 >   *   s->setData("OOPSE");
165 >   *   propMap->addProperty(s);
166 >   *  
167 >   *   gdata = propMap->getPropertyByName("MyStringGenericData");
168 >   *   if (gdata != NULL){
169 >   *     s = dynamic_cast<StringGenericData*>(gdata);
170 >   *     if (s != NULL)
171 >   *       std::cout << s->getData() << std::endl;
172 >   *   }
173 >   *
174 >   * @endcode
175 >   */  
176 >  typedef SimpleTypeData<std::string> StringGenericData;
177  
178 <    /**
179 <    * @class STLContainerTypeData
180 <    * @brief STL container type generic data which is associated with an id
181 <    *
182 <    * @template ContainerType
183 <    * @template ElemDataType
184 <    */
185 <    template <template<typename ELEM, typename = std::allocator<ELEM> > class ContainerType,
186 <                     typename ElemDataType >
187 <    class STLContainerTypeData : public GenericData, public ContainerType<ElemDataType>{
188 <        public:
172 <            typedef STLContainerTypeData<ContainerType, ElemDataType> SelfType;
173 <            typedef ContainerType<ElemDataType> STLContainerType;
178 >  /**
179 >   * @class STLContainerTypeData
180 >   * @brief STL container type generic data which is associated with an id
181 >   *
182 >   * @template ContainerType
183 >   * @template ElemDataType
184 >   */
185 >  template <typename ElemDataType >
186 >  class VectorTypeData : public GenericData {
187 >  public:
188 >    typedef VectorTypeData<ElemDataType> SelfType;
189  
190 <            STLContainerTypeData(const std::string& id)
191 <                : GenericData(id),  ContainerType<ElemDataType> () {}
190 >    VectorTypeData(const std::string& id)
191 >      : GenericData(id){}
192              
193 <            STLContainerTypeData(const SelfType& s) : SelfType(s){}
193 >    VectorTypeData(const SelfType& s) : data_(s){}
194  
195 <            SelfType& operator =(const SelfType& s){
196 <                if (this == &s)
197 <                    return *this;
195 >    SelfType& operator =(const SelfType& s){
196 >      if (this == &s)
197 >        return *this;
198  
199 <                STLContainerType::operator=(s);
200 <                return *this;
201 <            }
202 <    };
199 >      this->data_ = s.data_;
200 >      return *this;
201 >    }
202 >            
203 >  private:
204 >    std::vector<ElemDataType> data_;
205 >  };
206  
207 <    /**
208 <     * @typedef IntVectorGenericData
209 <     * A generic data type contains a vector<int> variable.
210 <     */  
211 <    typedef STLContainerTypeData<std::vector, int> IntVectorGenericData;
207 >  /**
208 >   * @typedef IntVectorGenericData
209 >   * A generic data type contains a  std::vector<int> variable.
210 >   */  
211 >  typedef VectorTypeData<int> IntVectorGenericData;
212  
213 <    /**
214 <     * @typedef IntVectorGenericData
215 <     * A generic data type contains a vector<float> variable.
216 <     */  
217 <    typedef STLContainerTypeData<std::vector, float> FloatVectorGenericData;
213 >  /**
214 >   * @typedef IntVectorGenericData
215 >   * A generic data type contains a  std::vector<float> variable.
216 >   */  
217 >  typedef VectorTypeData<float> FloatVectorGenericData;
218  
219 <    /**
220 <     * @typedef IntVectorGenericData
221 <     * A generic data type contains a vector<double> variable.
222 <     */  
223 <    typedef STLContainerTypeData<std::vector, double> DoubleVectorGenericData;
219 >  /**
220 >   * @typedef IntVectorGenericData
221 >   * A generic data type contains a  std::vector<RealType> variable.
222 >   */  
223 >  typedef VectorTypeData<RealType> DoubleVectorGenericData;
224  
225 <    /**
226 <     * @typedef StringVectorGenericData
227 <     *  A generic data type contains a vector<string> variable.
228 <     *
229 <     * @code
230 <     *  StringVectorGenericData* sv = new StringVectorGenericData("MyStringVector");
231 <     *  GenericData* gdata;
232 <     *  PropertyMap propMap;
233 <     *  std::vector<std::string>::iterator iter;
234 <     *  
235 <     *  sv->push_back("Hello World");
236 <     *  sv->push_back("OOPSE");
237 <     *
238 <     *  propMap.addProperty(sv);
239 <     *  
240 <     *  gdata = propMap.getProperty("MyStringVector");
241 <     *
242 <     *  if (gdata != NULL){
243 <     *
244 <     *    sv = dynamic_cast<StringVectorGenericData*>(gdata);
245 <     *
246 <     *    if (sv != NULL){
247 <     *      for (iter = sv->begin(); iter != sv->end(); ++ iter)
248 <     *        std::cout << *iter << std::endl;
249 <     *    }
250 <     *  }
251 <     * @endcode
252 <     */  
253 <    typedef STLContainerTypeData<std::vector, std::string> StringVectorGenericData;
236 <
237 <    /**
238 <     * @typedef IntVectorGenericData
239 <     * A generic data type contains a  list<vector<string> >  variable.
240 <     */  
241 <    typedef STLContainerTypeData<std::list, std::vector<int> > IntVectorListGenericData;
225 >  /**
226 >   * @typedef StringVectorGenericData
227 >   *  A generic data type contains a  std::vector<string> variable.
228 >   *
229 >   * @code
230 >   *  StringVectorGenericData* sv = new StringVectorGenericData("MyStringVector");
231 >   *  GenericData* gdata;
232 >   *  PropertyMap propMap;
233 >   *  std::vector<std::string>::iterator iter;
234 >   *  
235 >   *  sv->push_back("Hello World");
236 >   *  sv->push_back("OOPSE");
237 >   *
238 >   *  propMap.addProperty(sv);
239 >   *  
240 >   *  gdata = propMap.getPropertyByName("MyStringVector");
241 >   *
242 >   *  if (gdata != NULL){
243 >   *
244 >   *    sv = dynamic_cast<StringVectorGenericData*>(gdata);
245 >   *
246 >   *    if (sv != NULL){
247 >   *      for (iter = sv->begin(); iter != sv->end(); ++ iter)
248 >   *        std::cout << *iter << std::endl;
249 >   *    }
250 >   *  }
251 >   * @endcode
252 >   */  
253 >  typedef VectorTypeData<std::string> StringVectorGenericData;
254    
243 – #define CHIVALUE_ID "CHIVALUE"
244 – #define INTEGRALOFCHIDT_ID "INTEGRALOFCHIDT"
245 – #define ETAVALUE_ID "ETAVALUE"
255  
256   } // namespace oopse
257   #endif //UTIL _GENERICDATA_HPP

Diff Legend

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