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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
#ifndef __COMMAND_BASE_H__
#define __COMMAND_BASE_H__
/*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*/
#include <vector>
#include <QString>
#include "BrainModelAlgorithmException.h"
#include "CommandException.h"
#include "FileException.h"
#include "ProgramParametersException.h"
#include "ScriptBuilderParameters.h"
#include "StatisticException.h"
class GiftiNodeDataFile;
class NodeAttributeFile;
class ProgramParameters;
class VolumeFile;
/// base class for caret command line operations
class CommandBase {
public:
// constructor
CommandBase(const QString& operationSwitchIn,
const QString& shortDescriptionIn);
// destructor
virtual ~CommandBase();
// get all commands
static void getAllCommandsSortedBySwitch(std::vector<CommandBase*>& commandsOut);
// get all commands
static void getAllCommandsSortedByDescription(std::vector<CommandBase*>& commandsOut);
// set the parameters for the command
void setParameters(ProgramParameters* parametersIn);
/// get the operation switch
QString getOperationSwitch() const { return operationSwitch; }
/// get the short description of the command
QString getShortDescription() const { return shortDescription; }
// get full help information
virtual QString getHelpInformation() const = 0;
// execute the command (returns true if successful)
bool execute(QString& errorMessageOut);
/// get the script builder parameters
virtual void getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const = 0;
/// command requires GUI flag sent to QApplication to be true
virtual bool getHasGUI() const { return false; }
/// command has no parameters
virtual bool commandHasNoParameters() const { return false; }
/// get general help information
static QString getGeneralHelpInformation();
/// get the exit code
int getExitCode() const { return exitCode; }
protected:
// get all commands
static void getAllCommandsUnsorted(std::vector<CommandBase*>& commandsOut);
// execute the command
virtual void executeCommand() throw (BrainModelAlgorithmException,
CommandException,
FileException,
ProgramParametersException,
StatisticException) = 0;
/// get the name and label from a volume file name
void splitOutputVolumeNameIntoNameAndLabel(QString& nameInOut,
QString& labelOut) const;
/// read a volume file
void readVolumeFile(VolumeFile& vf,
const QString& name) throw (FileException);
/// write a volume file
void writeVolumeFile(VolumeFile& vf,
const QString& name,
const QString& label) throw (FileException);
/*
// get a node attribute file column number where input may be a column
// name or number. Input numbers range 1..N and output column
// numbers range 0..(N-1)
int getNodeAttributeFileColumnNumber(const GiftiNodeDataFile& gndf,
const QString& columnNameOrNumber) const throw (CommandException);
// get a node attribute file column number where input may be a column
// name or number. Input numbers range 1..N and output column
// numbers range 0..(N-1)
int getNodeAttributeFileColumnNumber(const NodeAttributeFile& gndf,
const QString& columnNameOrNumber) const throw (CommandException);
*/
/// checks for excessive parameters and throws exception if any are found
void checkForExcessiveParameters() throw (CommandException);
/// get pointer to empty parameters
static ProgramParameters* getEmptyParameters();
/// sets the exit code for the program (normally zero if no error).
void setExitCode(const int exitCodeIn) { exitCode = exitCodeIn; }
/// the switch that identifies the command
QString operationSwitch;
/// a short description of the command
QString shortDescription;
/// the commands parameters
ProgramParameters* parameters;
/// indentation of 3 spaces
static const QString indent3;
/// indentation of 6 spaces
static const QString indent6;
/// indentation of 9 spaces
static const QString indent9;
/// exit code for the program
int exitCode;
};
#ifdef __COMMAND_BASE_MAIN__
const QString CommandBase::indent3 = " ";
const QString CommandBase::indent6 = " ";
const QString CommandBase::indent9 = " ";
#endif // __COMMAND_BASE_MAIN__
#endif // __COMMAND_BASE_H__
|
