ml::RTObjectSaveBackgroundTask Class Reference
#include <mlRTObjectSave.h>
Inheritance diagram for ml::RTObjectSaveBackgroundTask:
Public Member Functions | |
| RTObjectSaveBackgroundTask (Module *module, FloatField *progressField, StringField *statusField) | |
| virtual | ~RTObjectSaveBackgroundTask () |
| void | setDicomTree (DCMTree::TreePtr dicomTree) |
| void | setFilename (const std::string &filename) |
| bool | hasSuccessfullySaved () const |
| virtual void | run () override |
| Method that needs to be reimplemented. This is called from the worker thread. | |
| Public Member Functions inherited from ml::ModuleBackgroundTask | |
| ModuleBackgroundTask (Module *module, FloatField *progressField=nullptr, StringField *statusField=nullptr) | |
| ~ModuleBackgroundTask () override | |
| void | setProgressField (FloatField *field) |
| void | setStatusField (StringField *field) |
| bool | hasProgressField () |
| bool | hasStatusField () |
| void | setStatusString (const std::string &status) override |
| void | setProgress (float progress) override |
| AsyncTileRequest | requestTile (int inputImageIndex, const SubImageBox &box, MLDataType type, const ScaleShiftData &shift=ScaleShiftData(), int getTileFlags=ImagingBackgroundTask::UseMemoryManager) |
| AsyncTileRequest | requestTileWithExternalBuffer (int inputImageIndex, const SubImageBox &box, MLDataType type, const ScaleShiftData &shift, ManagedSubImage *externalBuffer, int getTileFlags=ImagingBackgroundTask::ExternalBuffer) |
| ProcessAllPagesRequest | requestProcessAllPages (ProcessAllPagesHandler *handler, const SubImageBox &box=SubImageBox()) |
| ProcessAllPagesRequest | requestProcessAllPages (const SubImageBox &box=SubImageBox()) |
| virtual bool | shouldCancelOnInputImageChange (int) const |
| ImageVector | getInputImageExtent (int index=0) const |
Returns the extent of the input image at index. | |
| ImageVector | getInputImagePageExtent (int index=0) const |
Returns the page extent of the input image at index. | |
| MLDataType | getInputImageDataType (int index=0) const |
Returns the data type of the input image at index. | |
| double | getInputImageMinVoxelValue (int index=0) const |
Returns the minimum voxel value of the input image at index. | |
| double | getInputImageMaxVoxelValue (int index=0) const |
Returns the maximum voxel value of the input image at index. | |
| const MedicalImageProperties & | getInputImageProperties (int index=0) const |
Returns the image properties of the input image at index. | |
| bool | hasValidInputImage (int index=0) const |
Returns whether the input image at index is valid and thus its properties can be requested. | |
| int | getNumInputImages () const |
| Returns the number of input images. | |
| Public Member Functions inherited from ml::ImagingBackgroundTask | |
| ImagingBackgroundTask (void *owner) | |
| ~ImagingBackgroundTask () override | |
| Public Member Functions inherited from ml::MessagingBackgroundTask | |
| MessagingBackgroundTask (void *ownerArg) | |
| template<typename Object, typename Method> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method) |
| template<typename Object, typename Method, typename Arg1> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method, const Arg1 &arg1) |
| template<typename Object, typename Method, typename Arg1, typename Arg2> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method, const Arg1 &arg1, const Arg2 &arg2) |
| template<typename Object, typename Method, typename Arg1, typename Arg2, typename Arg3> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method, const Arg1 &arg1, const Arg2 &arg2, const Arg3 &arg3) |
| template<typename Object, typename Method, typename Arg1, typename Arg2, typename Arg3, typename Arg4> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method, const Arg1 &arg1, const Arg2 &arg2, const Arg3 &arg3, const Arg4 &arg4) |
| template<typename Object, typename Method, typename Arg1, typename Arg2, typename Arg3, typename Arg4, typename Arg5> | |
| void | callMethodOnGUI (const DistantObject< Object > &target, Method method, const Arg1 &arg1, const Arg2 &arg2, const Arg3 &arg3, const Arg4 &arg4, const Arg5 &arg5) |
| Public Member Functions inherited from ml::BackgroundTask | |
| BackgroundTask (void *owner) | |
| virtual | ~BackgroundTask () |
| bool | isSynchronous () const |
| Checks whether the task is synchronous, which means it is not executed in a different thread. | |
| void | setSynchronous (bool flag) |
| Sets whether the task is handled synchronously. Call this only in the setup of the task, not while it is already running. | |
| void | setSynchronousCancelField (NotifyField *field) |
| Sets a cancel field that is used in synchronous mode to check whether cancel was pressed. | |
| Status | status () const |
| void | cancel () |
| bool | isCanceled () const |
| bool | shouldStop () |
| void | resume () |
| void | suspend () |
| std::string | statusString () const |
| float | progress () const |
| void | setOwnerWasDeleted () |
| bool | hasOwner () const |
| void * | owner () const |
| void | waitAndExecuteNextMessage () |
| bool | executeNextMessage () |
| void | sendMessageToGUI (BackgroundTaskMessage *message) |
| void | logMessage (const std::string &message) |
| bool | isVerbose () const |
| Checks whether task uses verbose logging. | |
| void | setVerbose (bool flag) |
| double | runningTime () const |
| double | idleTime () const |
| void | getStatusInformation (BackgroundTaskStatusInformation &info) |
| MLuint32 | taskId () const |
| Returns the unique id of this task. The id of a task never changes. | |
| void | setTaskFinishedCB (BackgroundTaskFinishedCB *callback, void *userdata) |
| void | addObserver (Observer *observer) |
| void | removeObserver (Observer *observer) |
Additional Inherited Members | |
| Public Types inherited from ml::ImagingBackgroundTask | |
| enum | TileRequestFlags { UseMemoryManager = TileRequest::UseMemoryManager , UseMLAlloc = TileRequest::UseMLAlloc , NoAllocation = TileRequest::NoAllocation , ExternalBuffer = TileRequest::ExternalBuffer , AllocationPolicyMask = 0xf , RequestReadOnlyPage = 16 , ReceiveProgressMessages = 32 } |
| Public Types inherited from ml::BackgroundTask | |
| enum | Status { NotInTaskManager , Queued , Running , Finished , Canceled , Suspended } |
| Defines current status of the task. More... | |
| Protected Member Functions inherited from ml::ImagingBackgroundTask | |
| BackgroundRequestId | generateBackgroundRequestId () |
| Generates next generateBackgroundRequestId(). | |
| Protected Member Functions inherited from ml::BackgroundTask | |
| void | sendStatusChangedToObservers () |
| Sends the status change to all observers. | |
| void | sendStatusStringChangedToObservers () |
| Sends the status string change to all observers. | |
| void | sendLogMessageToObservers (const std::string &msg) |
| Sends the status string change to all observers. | |
| void | addIdleTime (double timeInSecs) |
Adds given timeInSecs as spent idle time. | |
Detailed Description
Definition at line 27 of file mlRTObjectSave.h.
Constructor & Destructor Documentation
◆ RTObjectSaveBackgroundTask()
| ml::RTObjectSaveBackgroundTask::RTObjectSaveBackgroundTask | ( | Module * | module, |
| FloatField * | progressField, | ||
| StringField * | statusField ) |
◆ ~RTObjectSaveBackgroundTask()
|
inlinevirtual |
Definition at line 33 of file mlRTObjectSave.h.
Member Function Documentation
◆ hasSuccessfullySaved()
|
inline |
Definition at line 52 of file mlRTObjectSave.h.
◆ run()
|
overridevirtual |
Method that needs to be reimplemented. This is called from the worker thread.
Implements ml::BackgroundTask.
◆ setDicomTree()
|
inline |
Definition at line 38 of file mlRTObjectSave.h.
References ml::BackgroundTask::isSynchronous().
◆ setFilename()
|
inline |
Definition at line 50 of file mlRTObjectSave.h.
The documentation for this class was generated from the following file:
- FMEwork/ReleaseMeVis/Projects/MLDcmtkMLConverterModules/Sources/mlRTObjectSave.h
