CSOListContainer

MLModule
genre CSOModule
author MeVis Medical Solutions AG
package MeVisLab/Standard
dll MLCSOModules
definition MLCSOModules.def
see also CSOManager

Purpose

The module CSOListContainer is a light-weight container for holding a CSOList.

The module is similar to CSOManager but without all the fields to control the default and current values of CSOs and CSOGroup.

The CSOListContainer also has no list views that show the CSOs and CSOGroup, and their connections; this module only shows the number of CSOs and CSOGroups in the CSOList for a fast overview.

Usage

Use this module instead of CSOManager if there should not be any interaction to select and/or combine CSOs with CSOGroups.

Because this module has only a few fields to update, applications using this module instead of the CSOManager will be faster.

Windows

Default Panel

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

Input Fields

inCSOList

name: inCSOList, type: CSOList(MLBase)
For accessing this object via scripting see the Scripting Reference: MLCSOListWrapper.

inUndoContext

name: inUndoContext, type: UndoContext(MLBase)
For accessing this object via scripting see the Scripting Reference: MLUndoContextWrapper.

Output Fields

outCSOList

name: outCSOList, type: CSOList(MLBase)
For accessing this object via scripting see the Scripting Reference: MLCSOListWrapper.

Parameter Fields

Field Index

Clear: Trigger
Copy Input CSOList: Trigger
Num CSOs: Integer
Num Groups: Integer
Use Undo Redo: Bool
Work directly on input CSOList: Bool

Visible Fields

Work directly on input CSOList

name: workDirectlyOnInputCSOList, type: Bool, default: FALSE

If checked, the module works directly on the input CSOList.

This is useful if only a CSOLoad module is used otherwise and there is the need to attach a UndoManager or to quickly Clear the CSOList.

Num CSOs

name: numCSOs, type: Integer, persistent: no

Shows the number of CSOs in the CSOList.

Num Groups

name: numGroups, type: Integer, persistent: no

Shows the number of CSOGroups in the CSOList.

Clear

name: clear, type: Trigger

If pressed, all CSOs and CSOGroups are removed.

Copy Input CSOList

name: copyInputCSOList, type: Trigger

If pressed, the current inCSOList is copied to the module’s output.

Use Undo Redo

name: useUndoRedo, type: Bool, default: TRUE

Sets whether actions on the CSOList should be recorded in the undo/redo manager.

This undo/redo manager is either the internal manager or the one provided by an attached UndoManager module.