IVISWTCH_ATTR_SCAN_LIST
IviSwtchScanner Attribute
| Data Type | Access | Applies to | Coercion | High Level Functions | Id Definition |
|---|---|---|---|---|---|
| ViString | R/W | N/A | None | IviSwtch_ConfigureScanList | 1250020 |
Description
Allows you to specify the channel list and order by providing a scan list string, which is then parsed by the driver. The basic unit in the scan list string is the channel pair, which can be separated by special symbols defined in the table below. Spaces are not significant to the syntax examples in the following table.
If the switch module is currently scanning through the scan list, setting this attribute returns the error IVISWTCH_ERROR_SCAN_IN_PROGRESS.
| Symbol | Symbol Name | Description | Syntax Examples |
|---|---|---|---|
| ; | Semi-colon | This character instructs the driver to wait for an input trigger event before proceeding to the next instruction in the scan list string. In the example, the driver notifies the switch module to create a path from channel CH1 to channel CH2, wait for a trigger, and then create a path from channel CH3 to channel CH4. | CH1 -> CH2 ; CH3 -> CH4 |
| & | Ampersand | This character instructs the driver to connect all the paths separated by the symbol at the same time, before the next trigger event. However, the driver does not guarantee the order of connection, except that all connections are settled before the next trigger event. In the example, the driver notifies the switch module to create a path between channels CH1 and CH2 and between channels CH3 and CH4, not necessarily in that order. The switch module then waits for a trigger before connecting channel A to channel B. | CH1 -> CH2 & CH3 -> CH4 ; A -> B |
| ~ | Tilde | This character instructs the driver to disconnect a path. In the example, the driver notifies the switch module to disconnect channel CH1 from channel CH2. Only a path connection event generates a scan-advanced trigger. Disconnecting a path will not generate a scan-advanced trigger. | ~CH1 -> CH2 |
| -> | Channel Pair | This symbol signifies a channel pair, which instructs the driver to create a path between the two channels separated by the symbol. In the example, the driver notifies the switch module to create a path from channel CH1 to channel CH2. | CH1 -> CH2 |