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
ctkCmdLineModuleFuture Class Reference

QFuture sub-class for enhanced communication with running modules. More...

#include <Libs/CommandLineModules/Core/ctkCmdLineModuleFuture.h>

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

Public Member Functions

bool canCancel () const
 Check if this module can be canceled via cancel(). More...
 
bool canPause () const
 Check if this module can be paused via pause() and similar QFuture methods. More...
 
 ctkCmdLineModuleFuture ()
 
QByteArray readAllErrorData () const
 Read all error data reported by the running module so far. More...
 
QByteArray readAllOutputData () const
 Read all output data reported by the running module so far. More...
 

Detailed Description

QFuture sub-class for enhanced communication with running modules.

Please see the QFuture documentation of Qt for details. This sub-class provides additional query methods to check if a module can be paused and/or canceled and also provides the ability to retrieve the arbitrary output and error data from the module.

See also
ctkCmdLineModuleFutureWatcher

Definition at line 43 of file ctkCmdLineModuleFuture.h.

Constructor & Destructor Documentation

◆ ctkCmdLineModuleFuture()

ctkCmdLineModuleFuture::ctkCmdLineModuleFuture ( )

Member Function Documentation

◆ canCancel()

bool ctkCmdLineModuleFuture::canCancel ( ) const

Check if this module can be canceled via cancel().

Returns
true if this module can be canceled, false otherwise.

◆ canPause()

bool ctkCmdLineModuleFuture::canPause ( ) const

Check if this module can be paused via pause() and similar QFuture methods.

Returns
true if this module can be paused, false otherwise.

◆ readAllErrorData()

QByteArray ctkCmdLineModuleFuture::readAllErrorData ( ) const

Read all error data reported by the running module so far.

Returns
Returns the reported error.

◆ readAllOutputData()

QByteArray ctkCmdLineModuleFuture::readAllOutputData ( ) const

Read all output data reported by the running module so far.

Returns
Returns the reported output.

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