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

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

Diff Legend

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