CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
ctkCmdLineModuleParameterGroup.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 __ctkCmdLineModuleParameterGroup_h
22 #define __ctkCmdLineModuleParameterGroup_h
23 
24 #include "ctkCommandLineModulesCoreExport.h"
25 
26 #include <QList>
27 #include <QSharedDataPointer>
28 
29 class QTextStream;
30 
32 struct ctkCmdLineModuleParameterGroupPrivate;
33 
39 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleParameterGroup
40 {
41 
42 public:
43 
46 
48 
49  QString label() const;
50 
51  QString description() const;
52 
53  bool advanced() const;
54 
56 
57  bool hasParameter(const QString& name) const;
58 
59  ctkCmdLineModuleParameter parameter(const QString& name) const;
60 
61  bool hasReturnParameters() const;
62 
63 private:
64 
65  friend class ctkCmdLineModuleXmlParser;
66 
68 
69  QSharedDataPointer<ctkCmdLineModuleParameterGroupPrivate> d;
70 };
71 
72 CTK_CMDLINEMODULECORE_EXPORT QTextStream & operator<<(QTextStream &os, const ctkCmdLineModuleParameterGroup& group);
73 
74 #endif
QList< ctkCmdLineModuleParameter > parameters() const
bool hasParameter(const QString &name) const
ctkCmdLineModuleParameter parameter(const QString &name) const
ctkCmdLineModuleParameterGroup & operator=(const ctkCmdLineModuleParameterGroup &other)
ctkCmdLineModuleParameterGroup(const ctkCmdLineModuleParameterGroup &other)
Single parameter to a module, like a threshold of a filter.
CTK_CMDLINEMODULECORE_EXPORT QTextStream & operator<<(QTextStream &os, const ctkCmdLineModuleParameterGroup &group)