Module Block
Overview
A Module block creates and completely defines a module, its inputs and outputs, and all control parameters. Module blocks are defined within layer blocks.
The block keyword itself takes a single (required) argument (the type of module to run) and an optional second argument specifying a unique name for the module, used to reference it from other modules in this or different layers.
Basic Keywords
Every module recognises the following keywords, giving control over its basic operation and definition.
| Keyword | Arguments | Default | Description |
|---|---|---|---|
Disabled |
– | – | Completely disables the module, preventing it from running within the current layer. |
EndModule |
– | – | Indicates the end of the current Module block. |
Frequency |
n |
1 |
Frequency n at which the module should be run. A frequency of 1 indicates that the module will run every time the encompassing processing layer is run, a value of 5 runs the module on every 5th execution of the layer. Note that the layer itself also has an associated frequency, relative the main loop counter. |
Target Keywords
Modules tend to require one or main “targets” upon which they operate or take data from. Most modules will target a single configuration in order to change its contents or make a meaningful calculation based on the current contents. Modules may also target other modules.
Control Keywords
In addition to the basic keywords, each module has its own unique set of control keywords used to set up and define its behaviour. Refer to the individual module pages for more information.
Example
Module 'TestModule' 'MyName'
Frequency 5
Disabled
ModuleOption1 ...
ModuleOption2 ...
...
EndModule