 |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
Go to the documentation of this file.
21 #ifndef __ctkCmdLineModuleDescription_h
22 #define __ctkCmdLineModuleDescription_h
24 #include <ctkCommandLineModulesCoreExport.h>
27 #include <QSharedDataPointer>
33 struct ctkCmdLineModuleDescriptionPrivate;
136 friend class ctkCmdLineModuleXmlParser;
137 friend struct ctkCmdLineModuleReferencePrivate;
141 QSharedDataPointer<ctkCmdLineModuleDescriptionPrivate> d;
bool hasParameter(const QString &name) const
Searches the list of parameters, checking if a parameter has the given name.
ctkCmdLineModuleDescription(const ctkCmdLineModuleDescription &description)
ctkCmdLineModuleParameter parameter(const QString &name) const
Returns the parameter specified by name.
CTK_CMDLINEMODULECORE_EXPORT QTextStream & operator<<(QTextStream &os, const ctkCmdLineModuleDescription &module)
QList< ctkCmdLineModuleParameterGroup > parameterGroups() const
The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterG...
Single parameter to a module, like a threshold of a filter.
QString title() const
Returns the title, derived from the.
Description of the parameters of a command line module.
~ctkCmdLineModuleDescription()
QString documentationURL() const
Returns the title, derived from the.
static ctkCmdLineModuleDescription parse(QIODevice *input)
QString acknowledgements() const
Returns the title, derived from the.
ctkCmdLineModuleDescription & operator=(const ctkCmdLineModuleDescription &other)
QIcon logo() const
Should return a QIcon, but does not appear to be supported yet.
QString license() const
Returns the title, derived from the.
bool hasReturnParameters() const
Does the module have any simple (primitive) return types?
QString categoryDotTitle() const
Helper method that returns the category followed by a dot followed by the title.
QString category() const
Returns the category, derived from the.
QString contributor() const
Returns the title, derived from the.
QString version() const
Returns the title, derived from the.
QString description() const
Returns the title, derived from the.