WEMPerformance¶
- MacroModule¶
genre
author
package
definition
see also
keywords
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¶
|
|
|
|
|
|
Visible Fields¶
Report¶
- name: report, type: String, persistent: no¶
Shows the found modules and their computation times in a HTML report.
Filter¶
- name: moduleString, type: String¶
Sets WEM module names as a comma- or space-separated list.
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: a substring-matching is performed on the filter string. The matching is performed both on the module names themselves and on the modules’ 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¶
Defines whether the listed modules are shown or ignored.
Values:
Title |
Name |
|---|---|
Show |
SHOW_MODULES |
Ignore |
IGNORE_MODULES |
Sort By¶
- name: sortBy, type: Enum, default: NO_SORTING¶
Defines the sorting of the module list.
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 |
Order¶
- name: sortOrder, type: Enum, default: ASCENDING¶
Defines how the sorting is ordered: ascending or descending.
Values:
Title |
Name |
|---|---|
Ascending |
ASCENDING |
Descending |
DESCENDING |
Reread Network¶
- name: rereadNetwork, type: Trigger¶
When pressed, the list of registered WEM modules is refreshed.
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.