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 | List of all members
ctkCmdLineModuleBackendXMLChecker Class Reference

Provides a ctkCmdLineModuleBackend implementation to pretend to run a command line process, but actually it returns a fixed, static piece of XML which can then be validated by the core library. More...

#include <Libs/CommandLineModules/Backend/XMLChecker/ctkCmdLineModuleBackendXMLChecker.h>

Inheritance diagram for ctkCmdLineModuleBackendXMLChecker:
Inheritance graph
[legend]
Collaboration diagram for ctkCmdLineModuleBackendXMLChecker:
Collaboration graph
[legend]

Public Member Functions

 ctkCmdLineModuleBackendXMLChecker ()
 
 ctkCmdLineModuleBackendXMLChecker (const QString &xmlToValidate)
 
virtual QString description () const
 Returns a brief description of the type of the backend. More...
 
virtual QString name () const
 Returns the name of the type of the backend, not the name of the thing or application that is run. More...
 
virtual QByteArray rawXmlDescription (const QUrl &location, int timeout)
 Get the raw XML description from the module at location. More...
 
virtual ctkCmdLineModuleFuture run (ctkCmdLineModuleFrontend *frontend)
 Run a front-end for this module in a local process. More...
 
virtual QList< QString > schemes () const
 This back-end can handle the "xml checker" URL scheme. More...
 
void setXML (const QString &xml)
 
virtual qint64 timeStamp (const QUrl &location) const
 Returns the last modified time of the module at location. More...
 
QString xml () const
 
 ~ctkCmdLineModuleBackendXMLChecker ()
 
- Public Member Functions inherited from ctkCmdLineModuleBackend
QByteArray rawXmlDescription (const QUrl &location)
 Get the XML parameter description from the given location. More...
 
virtual int timeOutForXmlRetrieval () const
 returns the number of milliseconds to wait when retrieving xml. More...
 
virtual ~ctkCmdLineModuleBackend ()
 

Additional Inherited Members

Detailed Description

Provides a ctkCmdLineModuleBackend implementation to pretend to run a command line process, but actually it returns a fixed, static piece of XML which can then be validated by the core library.

Definition at line 40 of file ctkCmdLineModuleBackendXMLChecker.h.

Constructor & Destructor Documentation

◆ ctkCmdLineModuleBackendXMLChecker() [1/2]

ctkCmdLineModuleBackendXMLChecker::ctkCmdLineModuleBackendXMLChecker ( )

◆ ctkCmdLineModuleBackendXMLChecker() [2/2]

ctkCmdLineModuleBackendXMLChecker::ctkCmdLineModuleBackendXMLChecker ( const QString &  xmlToValidate)

◆ ~ctkCmdLineModuleBackendXMLChecker()

ctkCmdLineModuleBackendXMLChecker::~ctkCmdLineModuleBackendXMLChecker ( )

Member Function Documentation

◆ description()

virtual QString ctkCmdLineModuleBackendXMLChecker::description ( ) const
virtual

Returns a brief description of the type of the backend.

Returns
A QString containing a description.

Implements ctkCmdLineModuleBackend.

◆ name()

virtual QString ctkCmdLineModuleBackendXMLChecker::name ( ) const
virtual

Returns the name of the type of the backend, not the name of the thing or application that is run.

Returns
A QString containing the name.

Implements ctkCmdLineModuleBackend.

◆ rawXmlDescription()

virtual QByteArray ctkCmdLineModuleBackendXMLChecker::rawXmlDescription ( const QUrl &  location,
int  timeout 
)
virtual

Get the raw XML description from the module at location.

Parameters
locationThe location URL of the module for which to get the XML description.
Returns
The raw XML description.

This method always calls the executable with a ––xml argument and returns the complete data emitted on the standard output channel.

Implements ctkCmdLineModuleBackend.

◆ run()

virtual ctkCmdLineModuleFuture ctkCmdLineModuleBackendXMLChecker::run ( ctkCmdLineModuleFrontend frontend)
virtual

Run a front-end for this module in a local process.

Parameters
frontendThe front-end to run.
Returns
A future object for communicating with the running process.

Implements ctkCmdLineModuleBackend.

◆ schemes()

virtual QList<QString> ctkCmdLineModuleBackendXMLChecker::schemes ( ) const
virtual

This back-end can handle the "xml checker" URL scheme.

Returns
Returns the schemes this back-end can handle.

Implements ctkCmdLineModuleBackend.

◆ setXML()

void ctkCmdLineModuleBackendXMLChecker::setXML ( const QString &  xml)

◆ timeStamp()

virtual qint64 ctkCmdLineModuleBackendXMLChecker::timeStamp ( const QUrl &  location) const
virtual

Returns the last modified time of the module at location.

Parameters
locationThe location URL of the module for which to get the timestamp.
Returns
A timestamp.

Implements ctkCmdLineModuleBackend.

◆ xml()

QString ctkCmdLineModuleBackendXMLChecker::xml ( ) const

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