CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Member Functions | Static Public Member Functions | Friends | List of all members
ctkCmdLineModuleDescription Class Reference

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...
 
ctkCmdLineModuleDescriptionoperator= (const ctkCmdLineModuleDescription &other)
 
ctkCmdLineModuleParameter parameter (const QString &name) const
 Returns the parameter specified by name. More...
 
QList< ctkCmdLineModuleParameterGroupparameterGroups () 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
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ctkCmdLineModuleDescription()

ctkCmdLineModuleDescription::ctkCmdLineModuleDescription ( const ctkCmdLineModuleDescription description)

◆ ~ctkCmdLineModuleDescription()

ctkCmdLineModuleDescription::~ctkCmdLineModuleDescription ( )

Member Function Documentation

◆ acknowledgements()

QString ctkCmdLineModuleDescription::acknowledgements ( ) const

Returns the title, derived from the.

QString acknowledgements() const
Returns the title, derived from the.

tag.

◆ category()

QString ctkCmdLineModuleDescription::category ( ) const

Returns the category, derived from the.

QString category() const
Returns the category, derived from the.

tag.

◆ categoryDotTitle()

QString ctkCmdLineModuleDescription::categoryDotTitle ( ) const

Helper method that returns the category followed by a dot followed by the title.

◆ contributor()

QString ctkCmdLineModuleDescription::contributor ( ) const

Returns the title, derived from the.

QString contributor() const
Returns the title, derived from the.

tag.

◆ description()

QString ctkCmdLineModuleDescription::description ( ) const

Returns the title, derived from the.

QString description() const
Returns the title, derived from the.

tag.

◆ documentationURL()

QString ctkCmdLineModuleDescription::documentationURL ( ) const

Returns the title, derived from the.

<documentation-url>

tag.

◆ hasParameter()

bool ctkCmdLineModuleDescription::hasParameter ( const QString &  name) const

Searches the list of parameters, checking if a parameter has the given name.

Parameters
namethe name of the parameter, derived from the
<name>
tag.
Returns
true if this module has a parameter called name and false otherwise

◆ hasReturnParameters()

bool ctkCmdLineModuleDescription::hasReturnParameters ( ) const

Does the module have any simple (primitive) return types?

◆ license()

QString ctkCmdLineModuleDescription::license ( ) const

Returns the title, derived from the.

QString license() const
Returns the title, derived from the.

tag.

◆ logo()

QIcon ctkCmdLineModuleDescription::logo ( ) const

Should return a QIcon, but does not appear to be supported yet.

◆ operator=()

ctkCmdLineModuleDescription& ctkCmdLineModuleDescription::operator= ( const ctkCmdLineModuleDescription other)

◆ parameter()

ctkCmdLineModuleParameter ctkCmdLineModuleDescription::parameter ( const QString &  name) const

Returns the parameter specified by name.

Parameters
namethe name of the parameter, derived from the
<name>
tag.
Returns
the parameter
Exceptions
ctkInvalidArgumentExceptionif this module does not have this parameter.

◆ parameterGroups()

QList<ctkCmdLineModuleParameterGroup> ctkCmdLineModuleDescription::parameterGroups ( ) const

The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterGroup to handle groups.

◆ parse()

static ctkCmdLineModuleDescription ctkCmdLineModuleDescription::parse ( QIODevice *  input)
static

◆ title()

QString ctkCmdLineModuleDescription::title ( ) const

Returns the title, derived from the.

QString title() const
Returns the title, derived from the.

tag.

◆ version()

QString ctkCmdLineModuleDescription::version ( ) const

Returns the title, derived from the.

QString version() const
Returns the title, derived from the.

tag.

Friends And Related Function Documentation

◆ ctkCmdLineModuleReferencePrivate

friend struct ctkCmdLineModuleReferencePrivate
friend

Definition at line 137 of file ctkCmdLineModuleDescription.h.

◆ ctkCmdLineModuleXmlParser

friend class ctkCmdLineModuleXmlParser
friend

Definition at line 136 of file ctkCmdLineModuleDescription.h.


The documentation for this class was generated from the following file: