User's Reference - IntegerList

### IntegerList

Category

Interactor

Function

Generates a list of integers within a specified range of values.

Syntax

Available only through the user interface.

Inputs

Name | Type | Default | Description
--- | --- | --- | ---
`data` | object | no default | object from which interactor attributes can be derived
`refresh` | flag | 0 | reset the interactor
`min` | integer | minimum data value | minimum output integer
`max` | integer | maximum data value | maximum output integer
`delta` | scalar | input dependent | increment between successive integer outputs
`method` | string | input dependent | defines interpretation of delta input
`nitems` | integer | 11 | number of items in the initial list
`label` | string | "IntegerList" | global name applied to interactor stand-ins

Outputs

Name | Type | Description
--- | --- | ---
`output` | integer list | interactor output

Functional Details

This interactor provides incremental control of various functions in a visual program (e.g., the number of contour lines currently displayed on an isosurface in the Image window). But it creates a list of integers, rather than a single integer, as Integer does.

The integer range over which the module acts is governed by its attributes (e.g., minimum, maximum, and delta), which in turn are either (1) specified by the parameter values in its configuration dialog box or (2) determined from input to the module (usually a data field). In the second case, the interactor is said to be "data driven."

If an interactor is not data driven, then the attributes (e.g., minimum, maximum, delta, etc.) are taken from the interactor's `Set Attributes...` dialog box (which is accessed from the `Edit` pull-down menu in the Control Panel).

Note: The interactor is invoked by double-clicking on its icon in the VPE window. Its configuration dialog box is accessed from the `Edit` pull-down menu in the same window.

`data` | is the object (usually a data field) from which the interactor can derive any or all of the minimum, maximum, and delta attributes when their corresponding input tabs are up.
`refresh` | resets the interactor so that the output is computed from the current input. If `refresh` = 0 (the default), the output is recomputed only if the current output does not lie within the range of the current `data`.
`min` and `max` | specify the minimum and maximum values of the interactor's integer output. If set, these values override those implied by `data`. If neither `min` nor `data` is specified, the interactor uses the minimum set in the `Set Attributes...` dialog box. If neither `max` nor `data` is specified, the interactor uses the maximum set in the `Set Attributes...` dialog box.
`delta` | specifies a scalar value as a factor for calculating the increment between successive outputs over the specified range. The actual value depends on the interpretation specified by `method` (see below).
`method` | specifies the interpretation of `delta`: "rounded": the increment (`max` - `min`) × `delta` is rounded to a "nice" number. The spacing between successive values will approximate the interval specified by `delta`. (For example, the default value of 0.01 specifies an interval of 1/100 of the specified range.) "relative": the interpretation is the same as for "rounded," but the increment is not rounded. "absolute": `delta` is the absolute value of the interval. (If `delta` has not been specified, its default is 1.) The default value for `method` depends on other input. The default is: "rounded" if `data` is specified or if both `min` and `max` are specified. "absolute" in all other cases.
`nitems` | specifies the number of items in a newly created list. These are evenly spaced between the minimum and maximum values (see above). For example, if this parameter is given a value of 5, and the range is 0-100, the output list will be {0, 25, 50, 75, 100}. Notes: If `nitems` changes, a new list is computed. This parameter takes affect only if the minimum and maximum are set with the `min` and `max` parameters or with `data` parameter.
`label` | is the global label of all instances of the corresponding interactor stand-in. An interactor instance's local label (set from the Control Panel) overrides a global label. By default, the global label is set by the user interface.

See Also

Integer, Scalar, ScalarList, Vector, VectorList

[ OpenDX Home at IBM | OpenDX.org ]