File: HistoryManager.h

package info (click to toggle)
itksnap 3.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 10,196 kB
  • ctags: 9,196
  • sloc: cpp: 62,895; sh: 175; makefile: 13
file content (136 lines) | stat: -rw-r--r-- 4,787 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*=========================================================================

  Program:   ITK-SNAP
  Module:    $RCSfile: SystemInterface.h,v $
  Language:  C++
  Date:      $Date: 2010/04/14 10:06:23 $
  Version:   $Revision: 1.11 $
  Copyright (c) 2003-2013 Paul A. Yushkevich and Guido Gerig

  This file is part of ITK-SNAP

  ITK-SNAP is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  -----

  Copyright (c) 2003 Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef HISTORYMANAGER_H
#define HISTORYMANAGER_H

#include <vector>
#include <map>
#include <string>
#include "PropertyModel.h"


class SystemInterface;
class Registry;

/**
 * @brief The HistoryManager class
 * This class manages file IO history in the SNAP application. Starting with
 * version 3.0, there is a global history for each kind of file (main image,
 * segmentation, label descriptions, etc) and a history associated with each
 * main image. This class maintains the history entries. Each history is a
 * "PropertyModel", so other objects can register to observe changes to the
 * history.
 */
class HistoryManager
{
public:

  // Typedef for history lists
  typedef std::vector<std::string> HistoryListType;

  // Typedef for the history model
  typedef AbstractPropertyModel<HistoryListType, TrivialDomain> AbstractHistoryModel;

  /** Update the history in one of the named categories. The last parameter
      is whether the history entry should be made local, i.e., associated
      with the currently loaded main image. */
  void UpdateHistory(const std::string &category,
                     const std::string &file,
                     bool make_local);

  /** Delete an item from the global history  */
  void DeleteHistoryItem(const std::string &category,
                         const std::string &file);

  /** Clear the local history - should be done when the main image is unloaded */
  void ClearLocalHistory();

  /** Get the model encapsulating local history */
  AbstractHistoryModel *GetLocalHistoryModel(const std::string &category);

  /** Get the model encapsulating local history */
  AbstractHistoryModel *GetGlobalHistoryModel(const std::string &category);

  /** Get the local history in a category (pass by value) */
  HistoryListType GetLocalHistory(const std::string &category);

  /** Get the global history in a category (pass by value)*/
  HistoryListType GetGlobalHistory(const std::string &category);

  /** Create a registry holding the local history */
  void SaveLocalHistory(Registry &folder)
    { SaveHistory(folder, m_LocalHistory); }

  /** Read a registry holding the local history */
  void LoadLocalHistory(Registry &folder)
    { LoadHistory(folder, m_LocalHistory); }

  /** Create a registry holding the local history */
  void SaveGlobalHistory(Registry &folder)
    { SaveHistory(folder, m_GlobalHistory); }

  /** Read a registry holding the local history */
  void LoadGlobalHistory(Registry &folder)
    { LoadHistory(folder, m_GlobalHistory); }


  HistoryManager();

protected:

  static const unsigned int HISTORY_SIZE_LOCAL, HISTORY_SIZE_GLOBAL;

  // Typedef the concrete history model
  typedef ConcretePropertyModel<HistoryListType, TrivialDomain> ConcreteHistoryModel;
  typedef SmartPtr<ConcreteHistoryModel> ConcreteHistoryModelPtr;

  // Array of histories for different types of files
  typedef std::map<std::string, ConcreteHistoryModelPtr> HistoryMap;
  HistoryMap m_LocalHistory, m_GlobalHistory;

  ConcreteHistoryModel *GetHistory(const std::string &category, HistoryMap &hmap);
  void SaveHistory(Registry &folder, HistoryMap &hmap);
  void LoadHistory(Registry &folder, HistoryMap &hmap);

  void UpdateHistoryList(
      ConcreteHistoryModel *model, const std::string &file, unsigned int maxsize);

  // The system interface class
  SystemInterface *m_SystemInterface;

};

#endif // HISTORYMANAGER_H