User's Reference - Route

### Route

Category

Flow Control

Function

Routes an object through selector-specified output paths.

Syntax

    output = Route(selector, input);

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`selector` | integer or integer list | 0 | paths for routing the input object
`input` | value list, string list, or object | no default | object to be routed

Outputs

Name | Type | Description
--- | --- | ---
`output` | object | a possible path for routing the input object
`...` |  | additional paths

Functional Details

This module determines which of several output paths are executed.

`selector` | specifies the output paths that are to be executed. If the specified value is: NULL or 0 (zero): none of the modules that use Route output are executed. n: specifies the consumer that is executed. If n = 1, the modules that use Route's first output are executed; if n = 2, the modules that use Route's second output are executed; and so on. This parameter may also specify a list of integers, allowing multiple output paths to execute.
`input` | specifies an object to be routed to the output paths that are to be executed.

A single Route module can specify a maximum of 21 outputs. In the user interface, the default number of enabled tabs is two. (Tabs can be added to the module icon and removed with the appropriate `...Input Tab` options in the `Edit` pull-down menu of the VPE.)

Notes:

1. Modules that use outputs that are not specified in the `selector` list are said to be "killed" and are not executed. If there are no outputs associated with `selector` (e.g., if `selector` is NULL or 0), none of the modules that use Route output is allowed to execute: all are killed.

   In general, modules that use the results of a killed module are also killed. An exception is Collect, which runs unless all inputs are killed (either by Route or by errors in modules that produce its inputs). .

2. In the scripting language, if the Route module is to work properly, it and modules downstream of it must be executed as part of a macro.

Components

All input components are propagated to the selected outputs.

Example Visual Programs

    UsingSwitchAndRoute.net
    UsingMessage.net
    SIMPLE/Route.net

See Also

Collect, Switch

Chapter 4. "Data Explorer Execution Model" in IBM Visualization Data Explorer User's Guide.

[ OpenDX Home at IBM | OpenDX.org ]