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. 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, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */
 
/**
 * @file SimSnapshotManager.hpp
 * @author tlin
 * @date 10/20/2004
 * @version 1.0
 */
#ifndef BRAINS_SIMSNAPSHOTMANAGER_HPP
#define BRAINS_SIMSNAPSHOTMANAGER_HPP

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

namespace OpenMD{

  //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 = 0);
    ~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:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	3166 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	gezelter	507	/*
2	gezelter	246	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	tim	149	*
4	gezelter	246	* 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	gezelter	1390	* 1. Redistributions of source code must retain the above copyright
10	gezelter	246	* notice, this list of conditions and the following disclaimer.
11			*
12	gezelter	1390	* 2. Redistributions in binary form must reproduce the above copyright
13	gezelter	246	* 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	gezelter	1390	*
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	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	tim	149	*/
42
43	gezelter	507	/**
44			* @file SimSnapshotManager.hpp
45			* @author tlin
46			* @date 10/20/2004
47			* @version 1.0
48			*/
49	gezelter	246	#ifndef BRAINS_SIMSNAPSHOTMANAGER_HPP
50			#define BRAINS_SIMSNAPSHOTMANAGER_HPP
51	tim	149
52	gezelter	246	#include "brains/Snapshot.hpp"
53	tim	149	#include "brains/SnapshotManager.hpp"
54
55	gezelter	1390	namespace OpenMD{
56	tim	149
57	gezelter	507	//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	gezelter	1710	SimSnapshotManager(SimInfo* info, int storageLayout = 0);
68	gezelter	507	~SimSnapshotManager();
69			virtual bool advance();
70	tim	149
71	gezelter	507	virtual Snapshot* getSnapshot(int id);
72	tim	149
73	gezelter	507	virtual int getCapacity();
74	tim	149
75	gezelter	507	virtual void setCapacity(int capacity);
76	tim	149
77	gezelter	507	private:
78			SimInfo* info_;
79			};
80	tim	149
81			}
82	gezelter	246	#endif //BRAINS_SIMSNAPSHOTMANAGER_HPP