module

Name

module -- Create list and delete scripted readout modules.

Synopsis

module name type ?options?

module -list ?pattern?

module -delete module-name

module -types

DESCRIPTION

This command is defined in scripted readout event segments. If no option value is provided a new module instance is created and any remaining command line parameters must be legal configuration option/value pairs for the moduld's config subcommand. The module's name becomes a Tcl command. See Module Subcommands for information about the subcommands that are suppported by modules. See the man page for each module type for information about the configuration options each module type supports.

If the -list option is provided, the names of all the known modules are returned as a Tcl list. The optional pattern parameter is a pattern that can contain glob wildcard matching characters. If provided, only the module names that match the pattern are listed. If not the default pattern is * which matches anything.

If the -delete is provided, the module named module-name is removed from the set of known modules. The affect of this on readout lists that contain that module (packets are also readout lists) is very badly defined.

The -types option lists the set of module types that can be created and provides a short description of each of them.