src/brains/BlockSnapshotManager.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.
 */
#ifndef BRAINS_BLOCKSNAPSHOTMANAGER_HPP
#define BRAINS_BLOCKSNAPSHOTMANAGER_HPP
#include <vector>

#include "brains/SnapshotManager.hpp"
namespace oopse {

class SimInfo;
class DumpReader;

typedef std::pair<int, int> SnapshotBlock;

/**
 * @class BlockSnapshotManager
 * @todo document
 */
class BlockSnapshotManager : public SnapshotManager{

    public:
        BlockSnapshotManager(SimInfo* info, const std::string& filename, int storageLayout, int blockCapacity = 2);
        ~BlockSnapshotManager();
        
        virtual Snapshot* getSnapshot(int id) { return snapshots_[id]; }

        /** Returns number of snapshot blocks in this BlockSnapshotManager*/
        int getNBlocks() {
            return blocks_.size();
        }

        SnapshotBlock getSnapshotBlock(int block) {
            return blocks_.at(block);
        }
        
        int getNActiveBlocks();
        

        bool isBlockActive(int block) {
            return  findActiveBlock(block) != activeBlocks_.end() ? true : false;
        }        

        bool loadBlock(int block);
        
        bool unloadBlock(int block);

        std::vector<int> getActiveBlocks();

        int getBlockCapacity() {
            return blockCapacity_;                
        }

        int getNFrames();
        
    private:

        std::vector<int>::iterator findActiveBlock(int block) {
            return std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
        }

        bool hasZeroRefBlock();

        int getFirstZeroRefBlock();

        void internalLoad(int block);
        void internalUnload(int block);
        Snapshot* loadFrame(int frame);
        
        SimInfo* info_;
        int blockCapacity_;

        std::vector<Snapshot*> snapshots_;
        std::vector<SnapshotBlock> blocks_;        
        std::vector<int> activeBlocks_;
        std::vector<int> activeRefCount_;
        
        int nAtoms_;
        int nRigidBodies_;
    
        DumpReader* reader_;
        int nframes_;
        int nSnapshotPerBlock_;

};

}

#endif
Revision:	2035
Committed:	Tue Feb 15 19:36:07 2005 UTC (19 years, 4 months ago) by tim
File size:	4119 byte(s)
Log Message:	BlockSnapshotManager is using reference counting now
#	User	Rev	Content
1	tim	2002	/*
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. 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			*/
41			#ifndef BRAINS_BLOCKSNAPSHOTMANAGER_HPP
42			#define BRAINS_BLOCKSNAPSHOTMANAGER_HPP
43	tim	2007	#include <vector>
44	tim	2002
45			#include "brains/SnapshotManager.hpp"
46			namespace oopse {
47
48			class SimInfo;
49			class DumpReader;
50
51			typedef std::pair<int, int> SnapshotBlock;
52
53			/**
54			* @class BlockSnapshotManager
55			* @todo document
56			*/
57	tim	2008	class BlockSnapshotManager : public SnapshotManager{
58	tim	2002
59			public:
60	tim	2008	BlockSnapshotManager(SimInfo* info, const std::string& filename, int storageLayout, int blockCapacity = 2);
61			~BlockSnapshotManager();
62	tim	2002
63	tim	2007	virtual Snapshot* getSnapshot(int id) { return snapshots_[id]; }
64	tim	2002
65			/** Returns number of snapshot blocks in this BlockSnapshotManager*/
66			int getNBlocks() {
67			return blocks_.size();
68			}
69
70			SnapshotBlock getSnapshotBlock(int block) {
71			return blocks_.at(block);
72			}
73
74			int getNActiveBlocks();
75
76	tim	2035
77			bool isBlockActive(int block) {
78			return findActiveBlock(block) != activeBlocks_.end() ? true : false;
79			}
80
81	tim	2002	bool loadBlock(int block);
82
83			bool unloadBlock(int block);
84
85			std::vector<int> getActiveBlocks();
86
87			int getBlockCapacity() {
88			return blockCapacity_;
89			}
90
91	tim	2006	int getNFrames();
92	tim	2002
93			private:
94
95	tim	2035	std::vector<int>::iterator findActiveBlock(int block) {
96			return std::find(activeBlocks_.begin(), activeBlocks_.end(), block);
97			}
98
99			bool hasZeroRefBlock();
100
101			int getFirstZeroRefBlock();
102
103			void internalLoad(int block);
104			void internalUnload(int block);
105	tim	2002	Snapshot* loadFrame(int frame);
106
107			SimInfo* info_;
108			int blockCapacity_;
109
110			std::vector<Snapshot*> snapshots_;
111			std::vector<SnapshotBlock> blocks_;
112			std::vector<int> activeBlocks_;
113	tim	2035	std::vector<int> activeRefCount_;
114	tim	2002
115			int nAtoms_;
116			int nRigidBodies_;
117
118			DumpReader* reader_;
119			int nframes_;
120			int nSnapshotPerBlock_;
121
122			};
123
124			}
125
126			#endif