src/brains/SnapshotManager.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 SnapshotManager.hpp
 * @author tlin
 * @date 10/20/2004
 * @time 23:56am
 * @version 1.0
 */
#ifndef BRAINS_SNAPSHOTMANAGER_HPP
#define BRAINS_SNAPSHOTMANAGER_HPP

#include "brains/Snapshot.hpp"

namespace oopse{

  /**
   * @class SnapshotManager SnapshotManager.hpp "brains/SnapshotManager.hpp"
   * @brief SnapshotManager class is an abstract class which maintains 
   * a series of snapshots.
   * 
   * @see SimSnapshotManager
   * @see PropSnapshotManager
   */
  class SnapshotManager {
  public:

    virtual ~SnapshotManager() {
      delete currentSnapshot_;
      delete previousSnapshot_;
    }
            
    virtual bool advance() { return true; }

    virtual Snapshot* getSnapshot(int id) = 0;

    /**
     * Returns the pointer of previous snapshot
     * @return the pointer of previous snapshot
     */
    Snapshot* getPrevSnapshot() {
      return previousSnapshot_;
    }

    /**
     * Returns the pointer of current snapshot
     * @return the pointer of current snapshot
     */            
    Snapshot* getCurrentSnapshot() {
      return currentSnapshot_;
    }

    int getStorageLayout() {
      return storageLayout_;
    }

  private:
    int storageLayout_;

  protected:

    SnapshotManager(int storageLayout) : storageLayout_(storageLayout), currentSnapshot_(NULL), previousSnapshot_(NULL) {
    }
            
    Snapshot* currentSnapshot_;
    Snapshot* previousSnapshot_;
            

  };

}
#endif //BRAINS_SNAPSHOTMANAGER_HPP

Revision:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 3 months ago) by gezelter
File size:	3565 byte(s)
Log Message:	xemacs has been drafted to perform our indentation services
#	User	Rev	Content
1	gezelter	2204	/*
2	gezelter	1930	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	1615	*
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	1615	*/
41	gezelter	1930
42	gezelter	2204	/**
43			* @file SnapshotManager.hpp
44			* @author tlin
45			* @date 10/20/2004
46			* @time 23:56am
47			* @version 1.0
48			*/
49	tim	1615	#ifndef BRAINS_SNAPSHOTMANAGER_HPP
50			#define BRAINS_SNAPSHOTMANAGER_HPP
51	tim	1630
52			#include "brains/Snapshot.hpp"
53
54	tim	1615	namespace oopse{
55
56	gezelter	2204	/**
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	gezelter	1930
67	gezelter	2204	virtual ~SnapshotManager() {
68			delete currentSnapshot_;
69			delete previousSnapshot_;
70			}
71	gezelter	1930
72	gezelter	2204	virtual bool advance() { return true; }
73	tim	1615
74	gezelter	2204	virtual Snapshot* getSnapshot(int id) = 0;
75	tim	1615
76	gezelter	2204	/**
77			* Returns the pointer of previous snapshot
78			* @return the pointer of previous snapshot
79			*/
80			Snapshot* getPrevSnapshot() {
81			return previousSnapshot_;
82			}
83	tim	1615
84	gezelter	2204	/**
85			* Returns the pointer of current snapshot
86			* @return the pointer of current snapshot
87			*/
88			Snapshot* getCurrentSnapshot() {
89			return currentSnapshot_;
90			}
91	tim	1615
92	gezelter	2204	int getStorageLayout() {
93			return storageLayout_;
94			}
95	tim	1639
96	gezelter	2204	private:
97			int storageLayout_;
98	gezelter	1930
99	gezelter	2204	protected:
100	tim	2191
101	gezelter	2204	SnapshotManager(int storageLayout) : storageLayout_(storageLayout), currentSnapshot_(NULL), previousSnapshot_(NULL) {
102			}
103	gezelter	1930
104	gezelter	2204	Snapshot* currentSnapshot_;
105			Snapshot* previousSnapshot_;
106	tim	1639
107	tim	1642
108	gezelter	2204	};
109	tim	1615
110			}
111			#endif //BRAINS_SNAPSHOTMANAGER_HPP
112