src/brains/SnapshotManager.hpp

/*
 * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
 * 
 * Contact: oopse@oopse.org
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
 
 /**
  * @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:
            SnapshotManager() : currentSnapshot_(NULL), previousSnapshot_(NULL) {
            }
            virtual ~SnapshotManager();
            virtual bool advance() = 0;

            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 getCapacity();

            virtual void setCapacity(int capacity);

            bool getNotifyStatus();
            
            void setNotifyStatus(bool status);

            void attach(SnapshotObserver*);

            void detach(SnapshotObserver*);

            void notify();

        protected:
            Snapshot* currentSnapshot_;
            Snapshot* previousSnapshot_;
            
        private:
            vector<SnapshotObserver*> observers_;

    };

}
#endif //BRAINS_SNAPSHOTMANAGER_HPP

Revision:	149
Committed:	Mon Oct 25 04:08:14 2004 UTC (20 years, 6 months ago) by tim
Original Path:	*trunk/src/brains/SnapshotManager.hpp*
File size:	2967 byte(s)
Log Message:	more classes get reconstructed
#	User	Rev	Content
1	tim	122	/*
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.
23			*
24			*/
25
26			/**
27			* @file SnapshotManager.hpp
28			* @author tlin
29			* @date 10/20/2004
30			* @time 23:56am
31			* @version 1.0
32			*/
33			#ifndef BRAINS_SNAPSHOTMANAGER_HPP
34			#define BRAINS_SNAPSHOTMANAGER_HPP
35	tim	137
36			#include "brains/Snapshot.hpp"
37
38	tim	122	namespace oopse{
39
40			/**
41			* @class SnapshotManager SnapshotManager.hpp "brains/SnapshotManager.hpp"
42	tim	146	* @brief SnapshotManager class is an abstract class which maintains
43			* a series of snapshots.
44			*
45			* @see SimSnapshotManager
46			* @see PropSnapshotManager
47	tim	122	*/
48			class SnapshotManager {
49			public:
50	tim	149	SnapshotManager() : currentSnapshot_(NULL), previousSnapshot_(NULL) {
51			}
52			virtual ~SnapshotManager();
53	tim	146	virtual bool advance() = 0;
54	tim	122
55	tim	149	virtual Snapshot* getSnapshot(int id) = 0;
56	tim	122
57	tim	149	/**
58			* Returns the pointer of previous snapshot
59			* @return the pointer of previous snapshot
60			*/
61			Snapshot* getPrevSnapshot() {
62			return previousSnapshot_;
63			}
64	tim	122
65	tim	149	/**
66			* Returns the pointer of current snapshot
67			* @return the pointer of current snapshot
68			*/
69			Snapshot* getCurrentSnapshot() {
70			return currentSnapshot_;
71			}
72	tim	122
73			int getCapacity();
74
75	tim	149	virtual void setCapacity(int capacity);
76	tim	146
77	tim	149	bool getNotifyStatus();
78	tim	146
79	tim	149	void setNotifyStatus(bool status);
80	tim	146
81			void attach(SnapshotObserver*);
82
83			void detach(SnapshotObserver*);
84
85			void notify();
86	tim	149
87			protected:
88			Snapshot* currentSnapshot_;
89			Snapshot* previousSnapshot_;
90	tim	146
91	tim	122	private:
92	tim	146	vector<SnapshotObserver*> observers_;
93	tim	149
94	tim	122	};
95
96			}
97			#endif //BRAINS_SNAPSHOTMANAGER_HPP
98