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. 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 SnapshotManager.hpp |
44 |
< |
* @author tlin |
45 |
< |
* @date 10/20/2004 |
46 |
< |
* @time 23:56am |
47 |
< |
* @version 1.0 |
48 |
< |
*/ |
41 |
> |
|
42 |
> |
/** |
43 |
> |
* @file SnapshotManager.hpp |
44 |
> |
* @author tlin |
45 |
> |
* @date 10/20/2004 |
46 |
> |
* @time 23:56am |
47 |
> |
* @version 1.0 |
48 |
> |
*/ |
49 |
|
#ifndef BRAINS_SNAPSHOTMANAGER_HPP |
50 |
|
#define BRAINS_SNAPSHOTMANAGER_HPP |
51 |
|
|
52 |
|
#include "brains/Snapshot.hpp" |
53 |
|
|
54 |
< |
namespace oopse{ |
54 |
> |
namespace OpenMD{ |
55 |
|
|
56 |
< |
/** |
57 |
< |
* @class SnapshotManager SnapshotManager.hpp "brains/SnapshotManager.hpp" |
58 |
< |
* @brief SnapshotManager class is an abstract class which maintains |
59 |
< |
* a series of snapshots. |
60 |
< |
* |
61 |
< |
* @see SimSnapshotManager |
62 |
< |
* @see PropSnapshotManager |
63 |
< |
*/ |
64 |
< |
class SnapshotManager { |
65 |
< |
public: |
56 |
> |
/** |
57 |
> |
* @class SnapshotManager SnapshotManager.hpp "brains/SnapshotManager.hpp" |
58 |
> |
* @brief SnapshotManager class is an abstract class which maintains |
59 |
> |
* a series of snapshots. |
60 |
> |
* |
61 |
> |
* @see SimSnapshotManager |
62 |
> |
* @see PropSnapshotManager |
63 |
> |
*/ |
64 |
> |
class SnapshotManager { |
65 |
> |
public: |
66 |
|
|
67 |
< |
virtual bool advance() = 0; |
68 |
< |
|
69 |
< |
Snapshot* getSnapshot(int id); |
67 |
> |
virtual ~SnapshotManager() { |
68 |
> |
delete currentSnapshot_; |
69 |
> |
delete previousSnapshot_; |
70 |
> |
} |
71 |
|
|
72 |
< |
Snapshot* getPrevSnapshot(); |
72 |
> |
virtual bool advance() { return true; } |
73 |
|
|
74 |
< |
void setCurrentSnapshot(); |
58 |
< |
|
59 |
< |
Snapshot* getCurrentSnapshot(); |
74 |
> |
virtual Snapshot* getSnapshot(int id) = 0; |
75 |
|
|
76 |
< |
void setCurrentSnapshot(); |
77 |
< |
|
78 |
< |
int getCapacity(); |
76 |
> |
/** |
77 |
> |
* Returns the pointer of previous snapshot |
78 |
> |
* @return the pointer of previous snapshot |
79 |
> |
*/ |
80 |
> |
Snapshot* getPrevSnapshot() { |
81 |
> |
return previousSnapshot_; |
82 |
> |
} |
83 |
|
|
84 |
< |
void setCapacity(); |
84 |
> |
/** |
85 |
> |
* Returns the pointer of current snapshot |
86 |
> |
* @return the pointer of current snapshot |
87 |
> |
*/ |
88 |
> |
Snapshot* getCurrentSnapshot() { |
89 |
> |
return currentSnapshot_; |
90 |
> |
} |
91 |
|
|
92 |
< |
void getNotifyStatus(); |
93 |
< |
|
94 |
< |
void setNotifyStatus(); |
92 |
> |
int getStorageLayout() { |
93 |
> |
return storageLayout_; |
94 |
> |
} |
95 |
|
|
96 |
< |
void attach(SnapshotObserver*); |
96 |
> |
private: |
97 |
> |
int storageLayout_; |
98 |
|
|
99 |
< |
void detach(SnapshotObserver*); |
99 |
> |
protected: |
100 |
|
|
101 |
< |
void notify(); |
101 |
> |
SnapshotManager(int storageLayout) : storageLayout_(storageLayout), currentSnapshot_(NULL), previousSnapshot_(NULL) { |
102 |
> |
} |
103 |
|
|
104 |
< |
private: |
105 |
< |
vector<Snapshot*> snapshots_; |
106 |
< |
vector<SnapshotObserver*> observers_; |
80 |
< |
}; |
104 |
> |
Snapshot* currentSnapshot_; |
105 |
> |
Snapshot* previousSnapshot_; |
106 |
> |
|
107 |
|
|
108 |
+ |
}; |
109 |
+ |
|
110 |
|
} |
111 |
|
#endif //BRAINS_SNAPSHOTMANAGER_HPP |
112 |
|
|