src/utils/GenericData.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. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman & Gezelter, in progress (2009).                        
 */
 
/**
 * @file GenericData.hpp
 * @brief
 * @author tlin
 * @date 09/20/2004
 * @time 9:30am
 * @version 1.0
 */
 
#ifndef UTIL_GENERICDATA_HPP
#define UTIL_GENERICDATA_HPP

#include <list>
#include <string>
#include <vector>
#include "config.h"
namespace OpenMD{

  /**
   * @ class GenericData GenericData.hpp "utils/GenericData.hpp"
   * @brief Base class for generic data which is associated with an id
   */
  class GenericData{
  public:
    GenericData() :  id_("UndefinedGenericData"){}

    GenericData(const std::string& id) {  setID(id);  }

    /** virtual destructor */
    virtual ~GenericData() {}


    /**
     *  Returns the id of this generic data
     *
     * @return the id of this generic data
     *
     * @see #setID
     */
    const std::string getID() const { return id_;  }

    /**
     *  Sets the id of this generic data
     *
     * @param id the id to be set
     *
     * @see #getID
     */
    void setID(const std::string& id) { id_ = id;  }

            
  private:
    GenericData(const GenericData&);
    GenericData& operator=(GenericData&);
    std::string id_;

  };

  /**
   * @class SimpleTypeData
   * @brief SimpleTypeData class is a POD  repository class 
   * @warning ElemDataType must be copy constructible, and copy assignable
   */
  template<typename ElemDataType> class SimpleTypeData : public GenericData{

  public:
    SimpleTypeData() :  GenericData(), data_(ElemDataType()) {}
    SimpleTypeData(const std::string& id) : GenericData(id), data_(ElemDataType()) {}
    SimpleTypeData(const std::string&id , const ElemDataType& data) : GenericData(id), data_(data) {}
    template<typename T>
    SimpleTypeData(const SimpleTypeData<T>& s) {
      data_ = s.getData();
    }

    SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<ElemDataType>& s) {
      if (this == &s)
        return *this;
                
      data_ = s.getData();
      return *this;                
    }
            
    template<typename T>
    SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<T>& s) {                
      data_ = s.getData();
      return *this;
    }
            
    /** Returns POD data */     
    const ElemDataType& getData() const {return data_;}
    ElemDataType& getData()  {return data_;}
    /**
     * Sets POD data
     * @data POD data to be set
     */
    void setData(const ElemDataType& data) { data_ = data;  }

  private:
    ElemDataType data_;
  };

  /** BoolGenericData is a generic data type contains a bool variable */
  typedef SimpleTypeData<bool> BoolGenericData;

  /** IntGenericData is a generic data type contains an integer variable */
  typedef SimpleTypeData<int> IntGenericData;

  /** FloatGenericData is a generic data type contains a float variable */
  typedef SimpleTypeData<float> FloatGenericData;

  /** DoubleGenericData is a generic data type contains a RealType variable */
  typedef SimpleTypeData<RealType> DoubleGenericData;
  
  /**
   * @typedef StringGenericData
   * A generic data type contains a  std::string variable
   *
   * @code
   *   StringGenericData* s = new StringGenericData("MyStringGenericData");
   *   PropertyMap propMap;
   *   GenericData* gdata;
   *
   *   s->setData("OpenMD");
   *   propMap->addProperty(s);
   *   
   *   gdata = propMap->getPropertyByName("MyStringGenericData");
   *   if (gdata != NULL){
   *     s = dynamic_cast<StringGenericData*>(gdata);
   *     if (s != NULL)
   *       std::cout << s->getData() << std::endl;
   *   }
   *
   * @endcode
   */  
  typedef SimpleTypeData<std::string> StringGenericData;

  /**
   * @class STLContainerTypeData 
   * @brief STL container type generic data which is associated with an id
   *
   * @template ContainerType
   * @template ElemDataType
   */
  template <typename ElemDataType > 
  class VectorTypeData : public GenericData {
  public:
    typedef VectorTypeData<ElemDataType> SelfType;

    VectorTypeData(const std::string& id) 
      : GenericData(id){}
            
    VectorTypeData(const SelfType& s) : data_(s){}

    SelfType& operator =(const SelfType& s){
      if (this == &s)
        return *this;

      this->data_ = s.data_;
      return *this;
    }
            
  private:
    std::vector<ElemDataType> data_;
  };

  /**
   * @typedef IntVectorGenericData
   * A generic data type contains a  std::vector<int> variable.
   */  
  typedef VectorTypeData<int> IntVectorGenericData;

  /**
   * @typedef IntVectorGenericData
   * A generic data type contains a  std::vector<float> variable.
   */  
  typedef VectorTypeData<float> FloatVectorGenericData;

  /**
   * @typedef IntVectorGenericData
   * A generic data type contains a  std::vector<RealType> variable.
   */  
  typedef VectorTypeData<RealType> DoubleVectorGenericData;

  /** 
   * @typedef StringVectorGenericData
   *  A generic data type contains a  std::vector<string> variable.
   *
   * @code
   *  StringVectorGenericData* sv = new StringVectorGenericData("MyStringVector");
   *  GenericData* gdata;
   *  PropertyMap propMap;
   *  std::vector<std::string>::iterator iter;
   *  
   *  sv->push_back("Hello World");
   *  sv->push_back("OpenMD");
   *
   *  propMap.addProperty(sv);
   *  
   *  gdata = propMap.getPropertyByName("MyStringVector");
   *
   *  if (gdata != NULL){
   * 
   *    sv = dynamic_cast<StringVectorGenericData*>(gdata);
   *
   *    if (sv != NULL){
   *      for (iter = sv->begin(); iter != sv->end(); ++ iter)
   *        std::cout << *iter << std::endl;
   *    }
   *  }
   * @endcode
   */  
  typedef VectorTypeData<std::string> StringVectorGenericData;
  

} // namespace OpenMD
#endif //UTIL _GENERICDATA_HPP
Revision:	1465
Committed:	Fri Jul 9 23:08:25 2010 UTC (14 years, 9 months ago) by chuckv
File size:	7770 byte(s)
Log Message:	Creating busticated version of OpenMD
#	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. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
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.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
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	/**
43	* @file GenericData.hpp
44	* @brief
45	* @author tlin
46	* @date 09/20/2004
47	* @time 9:30am
48	* @version 1.0
49	*/
50
51	#ifndef UTIL_GENERICDATA_HPP
52	#define UTIL_GENERICDATA_HPP
53
54	#include <list>
55	#include <string>
56	#include <vector>
57	#include "config.h"
58	namespace OpenMD{
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"){}
67
68	GenericData(const std::string& id) { setID(id); }
69
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_; }
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; }
91
92
93	private:
94	GenericData(const GenericData&);
95	GenericData& operator=(GenericData&);
96	std::string id_;
97
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{
106
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	SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<ElemDataType>& s) {
117	if (this == &s)
118	return *this;
119
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	}
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; }
138
139	private:
140	ElemDataType data_;
141	};
142
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;
148
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 RealType variable */
153	typedef SimpleTypeData<RealType> DoubleGenericData;
154
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("OpenMD");
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 <typename ElemDataType >
186	class VectorTypeData : public GenericData {
187	public:
188	typedef VectorTypeData<ElemDataType> SelfType;
189
190	VectorTypeData(const std::string& id)
191	: GenericData(id){}
192
193	VectorTypeData(const SelfType& s) : data_(s){}
194
195	SelfType& operator =(const SelfType& s){
196	if (this == &s)
197	return *this;
198
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 std::vector<int> variable.
210	*/
211	typedef VectorTypeData<int> IntVectorGenericData;
212
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 std::vector<RealType> variable.
222	*/
223	typedef VectorTypeData<RealType> DoubleVectorGenericData;
224
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("OpenMD");
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
255
256	} // namespace OpenMD
257	#endif //UTIL _GENERICDATA_HPP