![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
Defines a reference or handle to a module, including location, XML, description and access to the associated backend. More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleReference.h>
Public Member Functions | |
ctkCmdLineModuleBackend * | backend () const |
Get the back-end which was registered to handle this module. More... | |
ctkCmdLineModuleReference () | |
Creates an invalid module reference. More... | |
ctkCmdLineModuleReference (const ctkCmdLineModuleReference &ref) | |
ctkCmdLineModuleDescription | description () const |
Get the module description for the parameters. More... | |
QUrl | location () const |
Get the URL under which the module was registered. More... | |
operator bool () const | |
Conversion operator to test the validity of this module reference. More... | |
ctkCmdLineModuleReference & | operator= (const ctkCmdLineModuleReference &ref) |
QByteArray | rawXmlDescription () const |
Get the raw XML description, as supplied by the back-end. More... | |
QString | xmlValidationErrorString () const |
Retrieve a validation error string. More... | |
~ctkCmdLineModuleReference () | |
Friends | |
class | ctkCmdLineModuleManager |
uint CTK_CMDLINEMODULECORE_EXPORT | qHash (const ctkCmdLineModuleReference &) |
Defines a reference or handle to a module, including location, XML, description and access to the associated backend.
Instances of this class reference registered modules and can be used to retrieve information about their parameters or to create a specific front-end.
Definition at line 44 of file ctkCmdLineModuleReference.h.
ctkCmdLineModuleReference::ctkCmdLineModuleReference | ( | ) |
Creates an invalid module reference.
ctkCmdLineModuleReference::~ctkCmdLineModuleReference | ( | ) |
ctkCmdLineModuleReference::ctkCmdLineModuleReference | ( | const ctkCmdLineModuleReference & | ref | ) |
ctkCmdLineModuleBackend* ctkCmdLineModuleReference::backend | ( | ) | const |
Get the back-end which was registered to handle this module.
ctkCmdLineModuleDescription ctkCmdLineModuleReference::description | ( | ) | const |
Get the module description for the parameters.
ctkCmdLineModuleXmlException | if the raw XML description cannot be parsed. |
QUrl ctkCmdLineModuleReference::location | ( | ) | const |
Get the URL under which the module was registered.
ctkCmdLineModuleReference::operator bool | ( | ) | const |
Conversion operator to test the validity of this module reference.
ctkCmdLineModuleReference& ctkCmdLineModuleReference::operator= | ( | const ctkCmdLineModuleReference & | ref | ) |
QByteArray ctkCmdLineModuleReference::rawXmlDescription | ( | ) | const |
Get the raw XML description, as supplied by the back-end.
QString ctkCmdLineModuleReference::xmlValidationErrorString | ( | ) | const |
Retrieve a validation error string.
|
friend |
Definition at line 96 of file ctkCmdLineModuleReference.h.
|
friend |