ctkCmdLineModuleReference Class Reference

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 &)

Detailed Description

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.

Constructor & Destructor Documentation

ctkCmdLineModuleReference() [1/2]

ctkCmdLineModuleReference::ctkCmdLineModuleReference

(

)

Creates an invalid module reference.

~ctkCmdLineModuleReference()

ctkCmdLineModuleReference::~ctkCmdLineModuleReference

(

)

ctkCmdLineModuleReference() [2/2]

ctkCmdLineModuleReference::ctkCmdLineModuleReference

(

const ctkCmdLineModuleReference &

ref

)

Member Function Documentation

backend()

ctkCmdLineModuleBackend* ctkCmdLineModuleReference::backend

(

)

const

Get the back-end which was registered to handle this module.

Returns

The back-end handling this module.

description()

ctkCmdLineModuleDescription ctkCmdLineModuleReference::description

(

)

const

Get the module description for the parameters.

Returns

The XML description as a class representation.

Exceptions

ctkCmdLineModuleXmlException

if the raw XML description cannot be parsed.

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=()

ctkCmdLineModuleReference& ctkCmdLineModuleReference::operator=

(

const ctkCmdLineModuleReference &

ref

)

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.

Friends And Related Function Documentation

ctkCmdLineModuleManager

friend class ctkCmdLineModuleManager

friend

Definition at line 96 of file ctkCmdLineModuleReference.h.

qHash

uint CTK_CMDLINEMODULECORE_EXPORT qHash ( const ctkCmdLineModuleReference &  )

friend

---

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

• Libs/CommandLineModules/Core/ctkCmdLineModuleReference.h