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. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. 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.
 */
 
/**
 * @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>
namespace oopse{

    /**
     * @ 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 double variable */
    typedef SimpleTypeData<double> DoubleGenericData;
  
    /**
     * @typedef StringGenericData
     * A generic data type contains a  std::string variable
     *
     * @code
     *   StringGenericData* s = new StringGenericData("MyStringGenericData");
     *   PropertyMap propMap;
     *   GenericData* gdata;
     *
     *   s->setData("OOPSE");
     *   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 <template<typename ELEM, typename = std::allocator<ELEM> > class ContainerType,
                     typename ElemDataType > 
    class STLContainerTypeData : public GenericData, public ContainerType<ElemDataType>{
        public:
            typedef STLContainerTypeData<ContainerType, ElemDataType> SelfType;
            typedef ContainerType<ElemDataType> STLContainerType;

            STLContainerTypeData(const std::string& id) 
                : GenericData(id),  ContainerType<ElemDataType> () {}
            
            STLContainerTypeData(const SelfType& s) : SelfType(s){}

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

                STLContainerType::operator=(s);
                return *this;
            }
    };

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

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

    /**
     * @typedef IntVectorGenericData
     * A generic data type contains a  std::vector<double> variable.
     */  
    typedef STLContainerTypeData<std::vector, double> 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("OOPSE");
     *
     *  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 STLContainerTypeData<std::vector, std::string> StringVectorGenericData;

    /**
     * @typedef IntVectorGenericData
     * A generic data type contains a   std::list<vector<string> >  variable.
     */  
    typedef STLContainerTypeData<std::list, std::vector<int> > IntVectorListGenericData;
  
#define CHIVALUE_ID "CHIVALUE"
#define INTEGRALOFCHIDT_ID "INTEGRALOFCHIDT"
#define ETAVALUE_ID "ETAVALUE"

} // namespace oopse
#endif //UTIL _GENERICDATA_HPP
Revision:	1930
Committed:	Wed Jan 12 22:41:40 2005 UTC (19 years, 5 months ago) by gezelter
File size:	9066 byte(s)
Log Message:	merging new_design branch into OOPSE-2.0
#	User	Rev	Content
1	gezelter	1930	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	1625	*
4	gezelter	1930	* 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	tim	1625	*/
41	gezelter	1930
42	tim	1625	/**
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	gezelter	1490	#include <string>
56			#include <vector>
57	tim	1625	namespace oopse{
58	gezelter	1490
59	tim	1625	/**
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	gezelter	1490
67	tim	1625	GenericData(const std::string& id) { setID(id); }
68	gezelter	1490
69	tim	1625	/** virtual destructor */
70			virtual ~GenericData() {}
71	gezelter	1490
72
73	tim	1625	/**
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	gezelter	1490
82	tim	1625	/**
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	gezelter	1490
91	tim	1625
92			private:
93			GenericData(const GenericData&);
94			GenericData& operator=(GenericData&);
95			std::string id_;
96	gezelter	1490
97	tim	1625	};
98	gezelter	1490
99	tim	1625	/**
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	gezelter	1490
106	tim	1625	public:
107			SimpleTypeData() : GenericData(), data_(ElemDataType()) {}
108			SimpleTypeData(const std::string& id) : GenericData(id), data_(ElemDataType()) {}
109	gezelter	1930	SimpleTypeData(const std::string&id , const ElemDataType& data) : GenericData(id), data_(data) {}
110	tim	1625	template<typename T>
111			SimpleTypeData(const SimpleTypeData<T>& s) {
112			data_ = s.getData();
113			}
114	gezelter	1490
115	tim	1625	SimpleTypeData<ElemDataType>& operator =(const SimpleTypeData<ElemDataType>& s) {
116			if (this == &s)
117			return *this;
118
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			}
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; }
137	gezelter	1490
138	tim	1625	private:
139			ElemDataType data_;
140			};
141	gezelter	1490
142	tim	1625	/** BoolGenericData is a generic data type contains a bool variable */
143			typedef SimpleTypeData<bool> BoolGenericData;
144	gezelter	1490
145	tim	1625	/** IntGenericData is a generic data type contains an integer variable */
146			typedef SimpleTypeData<int> IntGenericData;
147	gezelter	1490
148	tim	1625	/** FloatGenericData is a generic data type contains a float variable */
149			typedef SimpleTypeData<float> FloatGenericData;
150	gezelter	1490
151	tim	1625	/** DoubleGenericData is a generic data type contains a double variable */
152			typedef SimpleTypeData<double> DoubleGenericData;
153
154			/**
155			* @typedef StringGenericData
156	gezelter	1930	* A generic data type contains a std::string variable
157	tim	1625	*
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	gezelter	1930	* gdata = propMap->getPropertyByName("MyStringGenericData");
167	tim	1625	* 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	gezelter	1490
177	tim	1625	/**
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 <template<typename ELEM, typename = std::allocator<ELEM> > class ContainerType,
185			typename ElemDataType >
186			class STLContainerTypeData : public GenericData, public ContainerType<ElemDataType>{
187			public:
188			typedef STLContainerTypeData<ContainerType, ElemDataType> SelfType;
189			typedef ContainerType<ElemDataType> STLContainerType;
190	gezelter	1490
191	tim	1625	STLContainerTypeData(const std::string& id)
192			: GenericData(id), ContainerType<ElemDataType> () {}
193
194			STLContainerTypeData(const SelfType& s) : SelfType(s){}
195	gezelter	1490
196	tim	1625	SelfType& operator =(const SelfType& s){
197			if (this == &s)
198			return *this;
199	gezelter	1490
200	tim	1625	STLContainerType::operator=(s);
201			return *this;
202			}
203			};
204	gezelter	1490
205	tim	1625	/**
206			* @typedef IntVectorGenericData
207	gezelter	1930	* A generic data type contains a std::vector<int> variable.
208	tim	1625	*/
209			typedef STLContainerTypeData<std::vector, int> IntVectorGenericData;
210	gezelter	1490
211	tim	1625	/**
212			* @typedef IntVectorGenericData
213	gezelter	1930	* A generic data type contains a std::vector<float> variable.
214	tim	1625	*/
215			typedef STLContainerTypeData<std::vector, float> FloatVectorGenericData;
216	gezelter	1490
217	tim	1625	/**
218			* @typedef IntVectorGenericData
219	gezelter	1930	* A generic data type contains a std::vector<double> variable.
220	tim	1625	*/
221			typedef STLContainerTypeData<std::vector, double> DoubleVectorGenericData;
222	gezelter	1490
223	tim	1625	/**
224			* @typedef StringVectorGenericData
225	gezelter	1930	* A generic data type contains a std::vector<string> variable.
226	tim	1625	*
227			* @code
228			* StringVectorGenericData* sv = new StringVectorGenericData("MyStringVector");
229			* GenericData* gdata;
230			* PropertyMap propMap;
231			* std::vector<std::string>::iterator iter;
232			*
233			* sv->push_back("Hello World");
234			* sv->push_back("OOPSE");
235			*
236			* propMap.addProperty(sv);
237			*
238	gezelter	1930	* gdata = propMap.getPropertyByName("MyStringVector");
239	tim	1625	*
240			* if (gdata != NULL){
241			*
242			* sv = dynamic_cast<StringVectorGenericData*>(gdata);
243			*
244			* if (sv != NULL){
245			* for (iter = sv->begin(); iter != sv->end(); ++ iter)
246			* std::cout << *iter << std::endl;
247			* }
248			* }
249			* @endcode
250			*/
251			typedef STLContainerTypeData<std::vector, std::string> StringVectorGenericData;
252	gezelter	1490
253	tim	1625	/**
254			* @typedef IntVectorGenericData
255	gezelter	1930	* A generic data type contains a std::list<vector<string> > variable.
256	tim	1625	*/
257			typedef STLContainerTypeData<std::list, std::vector<int> > IntVectorListGenericData;
258
259			#define CHIVALUE_ID "CHIVALUE"
260			#define INTEGRALOFCHIDT_ID "INTEGRALOFCHIDT"
261			#define ETAVALUE_ID "ETAVALUE"
262	gezelter	1490
263	tim	1625	} // namespace oopse
264			#endif //UTIL _GENERICDATA_HPP