![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
Description of the parameters of a command line module. More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleDescription.h>
Public Member Functions | |
QString | acknowledgements () const |
Returns the title, derived from the. More... | |
QString | category () const |
Returns the category, derived from the. More... | |
QString | categoryDotTitle () const |
Helper method that returns the category followed by a dot followed by the title. More... | |
QString | contributor () const |
Returns the title, derived from the. More... | |
ctkCmdLineModuleDescription (const ctkCmdLineModuleDescription &description) | |
QString | description () const |
Returns the title, derived from the. More... | |
QString | documentationURL () const |
Returns the title, derived from the. More... | |
bool | hasParameter (const QString &name) const |
Searches the list of parameters, checking if a parameter has the given name. More... | |
bool | hasReturnParameters () const |
Does the module have any simple (primitive) return types? More... | |
QString | license () const |
Returns the title, derived from the. More... | |
QIcon | logo () const |
Should return a QIcon, but does not appear to be supported yet. More... | |
ctkCmdLineModuleDescription & | operator= (const ctkCmdLineModuleDescription &other) |
ctkCmdLineModuleParameter | parameter (const QString &name) const |
Returns the parameter specified by name. More... | |
QList< ctkCmdLineModuleParameterGroup > | parameterGroups () const |
The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterGroup to handle groups. More... | |
QString | title () const |
Returns the title, derived from the. More... | |
QString | version () const |
Returns the title, derived from the. More... | |
~ctkCmdLineModuleDescription () | |
Static Public Member Functions | |
static ctkCmdLineModuleDescription | parse (QIODevice *input) |
Friends | |
struct | ctkCmdLineModuleReferencePrivate |
class | ctkCmdLineModuleXmlParser |
Description of the parameters of a command line module.
The parameters can be used for automated GUI generation or execution of the module, and are directly related to the XML description used to describe the command line module parameters.
Definition at line 46 of file ctkCmdLineModuleDescription.h.
ctkCmdLineModuleDescription::ctkCmdLineModuleDescription | ( | const ctkCmdLineModuleDescription & | description | ) |
ctkCmdLineModuleDescription::~ctkCmdLineModuleDescription | ( | ) |
QString ctkCmdLineModuleDescription::acknowledgements | ( | ) | const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::category | ( | ) | const |
Returns the category, derived from the.
tag.
QString ctkCmdLineModuleDescription::categoryDotTitle | ( | ) | const |
Helper method that returns the category followed by a dot followed by the title.
QString ctkCmdLineModuleDescription::contributor | ( | ) | const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::description | ( | ) | const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::documentationURL | ( | ) | const |
Returns the title, derived from the.
tag.
bool ctkCmdLineModuleDescription::hasParameter | ( | const QString & | name | ) | const |
Searches the list of parameters, checking if a parameter has the given name.
name | the name of the parameter, derived from the <name>
|
bool ctkCmdLineModuleDescription::hasReturnParameters | ( | ) | const |
Does the module have any simple (primitive) return types?
QString ctkCmdLineModuleDescription::license | ( | ) | const |
QIcon ctkCmdLineModuleDescription::logo | ( | ) | const |
Should return a QIcon, but does not appear to be supported yet.
ctkCmdLineModuleDescription& ctkCmdLineModuleDescription::operator= | ( | const ctkCmdLineModuleDescription & | other | ) |
ctkCmdLineModuleParameter ctkCmdLineModuleDescription::parameter | ( | const QString & | name | ) | const |
Returns the parameter specified by name.
name | the name of the parameter, derived from the <name>
|
ctkInvalidArgumentException | if this module does not have this parameter. |
QList<ctkCmdLineModuleParameterGroup> ctkCmdLineModuleDescription::parameterGroups | ( | ) | const |
The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterGroup to handle groups.
|
static |
QString ctkCmdLineModuleDescription::title | ( | ) | const |
QString ctkCmdLineModuleDescription::version | ( | ) | const |
|
friend |
Definition at line 137 of file ctkCmdLineModuleDescription.h.
|
friend |
Definition at line 136 of file ctkCmdLineModuleDescription.h.