CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleParameter.h
Go to the documentation of this file.
1 /*=============================================================================
2 
3  Library: CTK
4 
5  Copyright (c) 2010 Brigham and Women's Hospital (BWH) All Rights Reserved.
6 
7  Licensed under the Apache License, Version 2.0 (the "License");
8  you may not use this file except in compliance with the License.
9  You may obtain a copy of the License at
10 
11  http://www.apache.org/licenses/LICENSE-2.0
12 
13  Unless required by applicable law or agreed to in writing, software
14  distributed under the License is distributed on an "AS IS" BASIS,
15  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  See the License for the specific language governing permissions and
17  limitations under the License.
18 
19 =============================================================================*/
20 
21 #ifndef __ctkCmdLineModuleParameter_h
22 #define __ctkCmdLineModuleParameter_h
23 
24 #include "ctkCommandLineModulesCoreExport.h"
25 
26 #include <QSharedDataPointer>
27 
28 class QTextStream;
29 class QStringList;
30 
31 struct ctkCmdLineModuleParameterPrivate;
32 
44 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleParameter
45 {
46 
47 public:
48 
51 
53 
57  QString tag() const;
58 
62  QString type() const;
63 
68  bool hidden() const;
69 
77  bool isReturnParameter() const;
78 
83  bool isFlagParameter() const;
84 
88  bool isIndexParameter() const;
89 
93  QString name() const;
94 
98  QString longFlag() const;
99 
103  QString longFlagAliasesAsString() const;
104 
108  QStringList longFlagAliases() const;
109 
114 
118  QStringList deprecatedLongFlagAliases() const;
119 
123  QString label() const;
124 
128  bool constraints() const;
129 
133  QString maximum() const;
134 
138  QString minimum() const;
139 
143  QString step() const;
144 
148  QString description() const;
149 
153  QString channel() const;
154 
160  int index() const;
161 
165  QString defaultValue() const;
166 
171  QString flag() const;
172 
176  QString flagAliasesAsString() const;
177 
181  QStringList flagAliases() const;
182 
187 
191  QStringList deprecatedFlagAliases() const;
192 
197  bool multiple() const;
198 
203  QString fileExtensionsAsString() const;
204 
209  QStringList fileExtensions() const;
210 
215  QString coordinateSystem() const;
216 
220  QStringList elements() const;
221 
222 private:
223 
224  friend struct ctkCmdLineModuleParameterParser;
225  friend class ctkCmdLineModuleXmlParser;
226 
228 
229  QSharedDataPointer<ctkCmdLineModuleParameterPrivate> d;
230 };
231 
232 CTK_CMDLINEMODULECORE_EXPORT QTextStream& operator<<(QTextStream& os, const ctkCmdLineModuleParameter& parameter);
233 
234 #endif
Single parameter to a module, like a threshold of a filter.
QString deprecatedLongFlagAliasesAsString() const
QString channel() const
QStringList elements() const
QStringList fileExtensions() const
QString longFlagAliasesAsString() const
QString longFlag() const
QString deprecatedFlagAliasesAsString() const
bool isIndexParameter() const
QString fileExtensionsAsString() const
QStringList flagAliases() const
ctkCmdLineModuleParameter(const ctkCmdLineModuleParameter &other)
ctkCmdLineModuleParameter & operator=(const ctkCmdLineModuleParameter &other)
bool isFlagParameter() const
QString minimum() const
QStringList deprecatedLongFlagAliases() const
QStringList longFlagAliases() const
QString defaultValue() const
QStringList deprecatedFlagAliases() const
QString flagAliasesAsString() const
QString description() const
bool isReturnParameter() const
QString coordinateSystem() const
QString maximum() const
CTK_CMDLINEMODULECORE_EXPORT QTextStream & operator<<(QTextStream &os, const ctkCmdLineModuleParameter &parameter)