 |
ConfigureList()
| Public Function |
Declared in: NiIviSwtch.h |
Declaration
inline void ConfigureList(
const CString &List,
long mode);
Description
Configures the switch module for scanning.
Parameters
The scan list is a string that specifies channel connections and trigger conditions. The Initiate function makes or breaks connections and waits for triggers according to the instructions in the scan list.
The scan list is comprised of channel names that you separate with special characters. These special characters determine the operations the scanner performs on the channels when it executes this scan list.
To create a path between two channels, use the following character between the two channel names: -> (a dash followed by a '>' sign) Example: "CH1->CH2" tells the switch to make a path from channel CH1 to channel CH2.
To break or clear a path, use the following character as a prefix before the path: ~ (tilde) Example: "~CH1->CH2" tells the switch to break the path from channel CH1 to channel CH2.
To tell the switch module to wait for a trigger event, use the following character as a separator between paths: ; (semicolon) Example: "CH1->CH2;CH3->CH4" tells the switch to make the path from channel CH1 to channel CH2, wait for a trigger, and then make the path from CH3 to CH4.
To tell the switch module to create multiple paths simultaneously, use the following character as a separator between the paths: , (comma) Example: "A->B;CH1->CH2,CH3->CH4" instructs the scanner to make the path between channels A and B, wait for a trigger, and then simultaneously make the paths between channels CH1 and CH2 and between channels CH3 and CH4.
This function sets the List property to the value you specify for this parameter.
Specifies what happens to existing connections that conflict with the connections you make in a scan list. For example, if CH1 is already connected to CH2 and the scan list instructs the switch module to connect CH1 to CH3, this property specifies what happens to the connection between CH1 and CH2.
The following list includes valid values:
- CNiIviSwtch::None - Take no action on existing connections
- CNiIviSwtch::BreakBeforeMake - Break existing connections before making new connections.
- CNiIviSwtch::BreakAfterMake - Make new connections, then break existing connections
This function sets the Mode property to the value you specify for this parameter.
