WEMPerformance

MacroModule

genre	WEMInformation
status	stable
author	Bart De Dobbelaer
package	MeVisLab/Standard
definition	MLWEMModules.def
see also	WEMInfo
keywords	WEM, information, time, measurement

Purpose

The WEMPerformance module displays the elapsed times and total elapsed time for all WEM modules in the network.

Usage

Add the WEMPerformance module to any network containing WEM modules. If WEM modules are added or removed after the creation of the WEMPerformance module press the Reread Network button.

Windows

Main

Parameter Fields

Field Index

Filter: String

Module Mode: Enum

Order: Enum

Report: String

Reread Network: Trigger

Sort By: Enum

Visible Fields

Filter

name: moduleString, type: String

Add WEM module names as a comma- or space-separated list in the textfield. Depending on the setting of the Module Mode, those modules will be listed or ignored. If no modules names were entered, all modules are shown, independant of the show/ignore setting.

There is no need to enter the full name of the WEM modules that need to be filtered: substring matching is performed on the filter string. Matching is done both on the module names themselves and on the instance names. Have a look at the example network to see how the filter can be used.

Module Mode

name: moduleMode, type: Enum, default: IGNORE_MODULES

Sets if the list of given names will be listed or ignored.

Values:

Title	Name
Show	SHOW_MODULES
Ignore	IGNORE_MODULES

Order

name: sortOrder, type: Enum, default: ASCENDING

Controls how the sorting is ordered, ascending or descending.

Values:

Title	Name
Ascending	ASCENDING
Descending	DESCENDING

Report

name: report, type: String

Shows the found modules and their computation times in a HTML report.

Reread Network

name: rereadNetwork, type: Trigger

Click this button to refresh the list of registered WEM modules. When the WEMPerformance module is created, this is done automatically.

You only need to update the module list manually after creation of new or deletion of existing WEM modules.

Sort By

name: sortBy, type: Enum, default: NO_SORTING

Sort module list by specified sorting. Possible values are 'No Sorting' (modules are listed by creation time), Module Name, Instance Name or Elapsed Time. The Elapsed Time sorting allows for a good overview of the slowest modules.

Values:

Title	Name
No Sorting	NO_SORTING
Module Name	MODULE_NAME
Instance Name	INSTANCE_NAME
Elapsed Time	ELAPSED_TIME