CSOSave

MLModule

genre	CSOPersistence
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLCSOModules
definition	MLCSOModules.def
see also	CSOManager, CSOLoad
keywords	contour, persistence, ascii, binary

Purpose

The module CSOSave saves a CSOList with all its parameters.

Usage

Enter the path to the file that is to be saved to the File Name field. If Auto save is enabled, the file is instantly saved; otherwise, press Save In Background.

Details

The CSOList is saved with all its properties as a plain ASCII-file or in a binary format.

In the status field, the saving status and eventual error messages are displayed. On the module’s automatic panel, there is a boolean that reflects the saving status, too (named saveSuccess).

The module checks for the file extension being .cso. If the file extension is different or no extension is given at all, the module adds a .cso automatically and updates the File Name field accordingly. Files with a .cso extension can be dragged onto a MeVisLab network; then, a CSOLoad module is generated, which loads automatically the dropped file.

The module can save a CSOList in a background thread; click Save In Background to trigger the asynchronous saving. The automatic saving of a CSOList is always synchronous.

Windows

Default Panel

Input Fields

inCSOList

name: inCSOList, type: CSOList(MLBase)

The CSOList that is to be saved.

For accessing this object via scripting, see the Scripting Reference: MLCSOListWrapper.

Parameter Fields

Field Index

Auto save: Bool	saveSuccess: Bool
Binary: Bool	Status: String
Cancel: Trigger	taskCanceled: Trigger
File Name: String	taskFinished: Trigger
Listen To Finished Notifications: Bool	taskRunning: Bool
progress: Float	taskVerboseLogging: Bool
Save: Trigger
Save In Background: Trigger

Visible Fields

Save In Background

name: startTask, type: Trigger

When pressed, the module saves the attached CSOList in a background thread.

Save

name: startTaskSynchronous, type: Trigger, deprecated name: apply

When pressed, the attached CSOList is saved.

Cancel

name: cancelTask, type: Trigger

When pressed, the saving in background is being canceled.

Note that on canceling the saving in the background, the .cso file is probably only partially written and thus corrupt.

Status

name: status, type: String, persistent: no

Shows the status of the module and the saving process.

File Name

name: fileName, type: String

Sets the file name of the target file. Note that the ending .cso is added automatically if missing.

Auto save

name: autoApply, type: Bool, default: FALSE

If checked, the module saves the attached CSOList if any GUI field (including the File Name) is changed.

Binary

name: binary, type: Bool, default: TRUE

If checked, the file is saved in a binary format, as ASCII otherwise.

Listen To Finished Notifications

name: listenToFinishedNotifications, type: Bool, default: FALSE

If checked, the module saves the attached CSOList if the finished notification was triggered.

Hidden Fields

taskVerboseLogging

name: taskVerboseLogging, type: Bool, default: FALSE

taskFinished

name: taskFinished, type: Trigger

taskCanceled

name: taskCanceled, type: Trigger

taskRunning

name: taskRunning, type: Bool, persistent: no, deprecated name: isProcessing

progress

name: progress, type: Float, persistent: no

saveSuccess

name: saveSuccess, type: Bool, default: FALSE