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.
More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleReference.h>
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() [1/2]
ctkCmdLineModuleReference::ctkCmdLineModuleReference |
( |
| ) |
|
Creates an invalid module reference.
◆ ~ctkCmdLineModuleReference()
ctkCmdLineModuleReference::~ctkCmdLineModuleReference |
( |
| ) |
|
◆ ctkCmdLineModuleReference() [2/2]
◆ backend()
Get the back-end which was registered to handle this module.
- Returns
- The back-end handling this module.
◆ description()
Get the module description for the parameters.
- Returns
- The XML description as a class representation.
- Exceptions
-
◆ location()
QUrl ctkCmdLineModuleReference::location |
( |
| ) |
const |
Get the URL under which the module was registered.
- Returns
- The module location.
◆ operator bool()
ctkCmdLineModuleReference::operator bool |
( |
| ) |
const |
Conversion operator to test the validity of this module reference.
◆ operator=()
◆ rawXmlDescription()
QByteArray ctkCmdLineModuleReference::rawXmlDescription |
( |
| ) |
const |
Get the raw XML description, as supplied by the back-end.
- Returns
- The raw XML description.
◆ xmlValidationErrorString()
QString ctkCmdLineModuleReference::xmlValidationErrorString |
( |
| ) |
const |
Retrieve a validation error string.
- Returns
- A non-empty string describing the validation error, if validation of the XML description was not successful.
◆ ctkCmdLineModuleManager
◆ qHash
The documentation for this class was generated from the following file: