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

#include "brains/Snapshot.hpp"
#include "brains/SnapshotManager.hpp"

namespace oopse{

  //forward declaration
  class SimInfo;
  /**
   * @class SimSnapshotManager SimSnapshotManager.hpp "brains/SimSnapshotManager.hpp"
   * @brief SimSnapshotManager class is the concrete snapshot manager for actual simulation
   * SimSnapshotManager only maintains two snapshots. 
   * @see PropSimSnapshotManager
   */
  class SimSnapshotManager : public SnapshotManager {
  public:
    SimSnapshotManager(SimInfo* info, int storageLayout = 255);
    ~SimSnapshotManager();
    virtual bool advance();

    virtual Snapshot* getSnapshot(int id);
            
    virtual int getCapacity();

    virtual void setCapacity(int capacity);
            
  private:
    SimInfo* info_;
  };

}
#endif //BRAINS_SIMSNAPSHOTMANAGER_HPP
Revision:	2204
Committed:	Fri Apr 15 22:04:00 2005 UTC (19 years, 2 months ago) by gezelter
File size:	3076 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	1642	*
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	1642	*/
41
42	gezelter	2204	/**
43			* @file SimSnapshotManager.hpp
44			* @author tlin
45			* @date 10/20/2004
46			* @time 23:56am
47			* @version 1.0
48			*/
49	gezelter	1930	#ifndef BRAINS_SIMSNAPSHOTMANAGER_HPP
50			#define BRAINS_SIMSNAPSHOTMANAGER_HPP
51	tim	1642
52	gezelter	1930	#include "brains/Snapshot.hpp"
53	tim	1642	#include "brains/SnapshotManager.hpp"
54
55			namespace oopse{
56
57	gezelter	2204	//forward declaration
58			class SimInfo;
59			/**
60			* @class SimSnapshotManager SimSnapshotManager.hpp "brains/SimSnapshotManager.hpp"
61			* @brief SimSnapshotManager class is the concrete snapshot manager for actual simulation
62			* SimSnapshotManager only maintains two snapshots.
63			* @see PropSimSnapshotManager
64			*/
65			class SimSnapshotManager : public SnapshotManager {
66			public:
67			SimSnapshotManager(SimInfo* info, int storageLayout = 255);
68			~SimSnapshotManager();
69			virtual bool advance();
70	tim	1642
71	gezelter	2204	virtual Snapshot* getSnapshot(int id);
72	tim	1642
73	gezelter	2204	virtual int getCapacity();
74	tim	1642
75	gezelter	2204	virtual void setCapacity(int capacity);
76	tim	1642
77	gezelter	2204	private:
78			SimInfo* info_;
79			};
80	tim	1642
81			}
82	gezelter	1930	#endif //BRAINS_SIMSNAPSHOTMANAGER_HPP