CSOSave¶

MLModule¶

genre	`CSOPersistence`
status	`stable`
author	`Olaf Konrad`
package	`MeVisLab/Standard`
dll	`MLCSOModules`
definition	MLCSOModules.def
see also	`CSOManager`, `CSOLoad`
keywords	`CSO`, `contour`

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.

Details¶

The CSOList is saved with all its properties as a plain ASCII-file or as 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 ending being .cso. If the file ending is different or no ending is given at all, the module adds a .cso automatically and updates the File Name field accordingly. Files with a .cso ending can be dragged onto a MeVisLab network; then, a CSOLoad module is generated which loads automatically the dropped file.

Windows¶

Default Panel¶

../../../Modules/ML/MLCSOModules/mhelp/Images/Screenshots/CSOSave._default.png

Input Fields¶

inCSOList¶

name: inCSOList, type: MLBase¶: The CSOList that is to be saved.

Parameter Fields¶

Field Index¶

`Auto save`: `Bool`	`Status`: `String`
`Binary`: `Bool`	`updateMode`: `Enum`
`done`: `Trigger`
`File Name`: `String`
`isProcessing`: `Bool`
`Listen To Finished Notifications`: `Bool`
`Save`: `Trigger`
`saveSuccess`: `Bool`

Visible Fields¶

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.

Save¶

name: apply, type: Trigger¶: If pressed, the attached CSOList is saved.

File Name¶

name: fileName, type: String¶: Sets the file name of the target file. Note that the ending .cso is added automatically if missing.

Status¶

name: status, type: String, default: Ready.¶: Shows the status of the module and the saving process.

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¶

updateMode¶

name: updateMode, type: Enum, default: Off¶

Values:

Title	Name
Off	Off
Auto Update	AutoUpdate

isProcessing¶

name: isProcessing, type: Bool, default: FALSE¶

done¶

name: done, type: Trigger¶

saveSuccess¶

name: saveSuccess, type: Bool, default: FALSE¶

Navigation