File: BrainModelAlgorithm.h

package info (click to toggle)
caret 5.6.4~dfsg.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 31,904 kB
  • ctags: 28,901
  • sloc: cpp: 378,050; python: 6,718; ansic: 5,507; makefile: 333; sh: 46
file content (99 lines) | stat: -rw-r--r-- 3,044 bytes parent folder | download | duplicates (2)
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
/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET 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 CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/



#ifndef __VE_BRAIN_MODEL_ALGORITHM_H__
#define __VE_BRAIN_MODEL_ALGORITHM_H__

#include <QObject>

#include "BrainModelAlgorithmException.h"

class QProgressDialog;

class BrainSet;
class QString;

/// Abstract class for algorithms that operate on brain models
class BrainModelAlgorithm : public QObject {
   Q_OBJECT
   
   public:
      /// execute the algorithm
      virtual void execute() throw (BrainModelAlgorithmException) = 0;
      
      /// Destructor
      virtual ~BrainModelAlgorithm();
      
      /// get warnings from execution
      QString getWarningMessages() const { return warningMessages; }
   
      /// get a text description of algorithm
      virtual QString getTextDescription() const;
      
   signals:
      /// signal emitted to indicate progress
      void signalProgressUpdate(const QString& text,
                                const int progressNumber,
                                const int totalNumberOfSteps);
      
   protected:
      /// Constructor
      BrainModelAlgorithm(BrainSet* bs);
      
      /// Create the progress dialog.
      void createProgressDialog(const QString& title,
                                const int totalNumberOfSteps,
                                const QString& dialogName);
      
      /// Update the progress dialog.  Throws exception if cancel button pressed by user.
      void updateProgressDialog(const QString& text,
                                const int progressNumber = -1,
                                const int totalNumberOfSteps = -1) throw (BrainModelAlgorithmException);


      /// Remove and delete the progress dialog.
      void removeProgressDialog();

      /// add to warning messages (newline automatically added after message)
      void addToWarningMessages(const QString& msg);
      
      /// allow GUI events to process
      void allowEventsToProcess();
      
      /// the brain set
      BrainSet* brainSet;
      
      /// the progress dialog
      QProgressDialog* progressDialog;
      
      /// warnings encountered during algorithm execution
      QString warningMessages;
      
};

#endif // __VE_BRAIN_MODEL_ALGORITHM_H__