SwitchScan Members
- Updated2023-02-21
- 8 minute(s) read
The SwitchScan type exposes the following members.
Name | Description | |
---|---|---|
![]() | Abort | Aborts the scan in progress. Initiate a scan with SwitchScan.Initiate. If the switch module is not scanning, exception is returned. |
![]() | Commit | Downloads the configured SwitchScan.List and trigger settings to hardware. |
![]() | ConfigureList | Configures the SwitchScan.List and SwitchScan.Mode used for scanning. Refer to Switch Device Help to determine if the switch module supports scanning. The SwitchScan.List is comprised of a list of channel connections separated by semicolons. For example, the following scan list will scan the first three channels of a multiplexer: com0->ch0; com0->ch1; com0->ch2; Refer to SwitchScan.List for more information on scan list syntax. To see the status of the scan, call either SwitchScan.IsScanning or SwitchScan.WaitForScanComplete. Use the SwitchScan.ConfigureTrigger method to configure the scan trigger. Use the SwitchScan.Initiate method to start the scan. |
![]() | ConfigureTrigger | Configures the scan triggers for the scan list established with SwitchScan.ConfigureList. Refer to Device Help to determine if the switch module supports scanning. SwitchScan.ConfigureTrigger sets the location that the switch expects to receive an input trigger to advance through the SwitchScan.List. This method also sets the location where it outputs a scan advanced signal after it completes an entry in the scan list. |
![]() | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Initiate | Commits the configured SwitchScan.List and trigger settings to hardware and initiates the scan. If SwitchScan.Commit was called earlier, SwitchScan.Initiate only initiates the scan and returns immediately. Once the scanning operation begins, you cannot perform any other operation other than GetAttribute, SwitchScan.Abort, or SwitchScan.SendSoftwareTrigger. All other functions return the Exception. To stop the scanning operation, call SwitchScan.Abort. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RouteScanAdvancedOutput | Routes the SwitchScan.AdvancedOutput from a trigger bus line (TTLx) to the front or rear connector. |
![]() | RouteTriggerInput | Routes the SwitchScan.TriggerInput from the front or rear connector to a trigger bus line (TTLx). To disconnect the route, call this function again and specify SwitchScanTriggerInputBusLine.None for trigger bus line parameter. |
![]() | Scan | Takes the SwitchScan.List provided, programs the switching hardware and initiates the scan. Once initiation is complete, the operation will return. |
![]() | SendSoftwareTrigger | Sends a software trigger to the switch specified in the NI-SWITCH session. When the SwitchScan.TriggerInput is set to SwitchScanTriggerInput.SoftwareTrigger through either the SwitchScan.ConfigureTrigger function or the SwitchScan.TriggerInput attribute, the scan does not proceed from a semicolon (wait for trigger) until SwitchScan.SendSoftwareTrigger is called. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | WaitForScanComplete | Pauses until the switch stops scanning or until the maximum time has elapsed, when NI-SWITCH returns a timeout error. |
Properties
Name | Description | |
---|---|---|
![]() | AdvancedOutput | Gets or sets a value which specifies the method you want to use to notify another instrument that all signals going through the switch have settled following the processing of one entry in the SwitchScan.List. |
![]() | AdvancedPolarity | Gets or sets the advance polarity for the scan. |
![]() | Continuous | Gets or sets a value that indicates whether a switch device stops scanning at the end of the scan, or continues scanning from the top of the scan list. Notice that if you set the scan to continuous trueTruetruetrue (True in Visual Basic), the SwitchScan.WaitForScanComplete method will always time out and you must call SwitchScan.Abort to stop the scan. |
![]() | Delay | Gets or sets a value which indicates the minimum amount of time, in seconds, the Switch device waits before it asserts the SwitchScan.AdvancedOutput trigger after opening or closing the switch. The switch always SwitchPath.WaitForDebounce before asserting the trigger. |
![]() | DigitalFilterEnable | Gets or sets a value which indicates whether to apply the pulse width to the SwitchScan.TriggerInput. Set the property to trueTruetruetrue (True in Visual Basic) to prevent the switch module from being triggered by pulses that are less than 150 ns on PXI trigger lines 0-7. When this property is set to falseFalsefalsefalse (False in Visual Basic), noise on the PXI trigger lines might trigger the switch module. If the device triggering the switch module can send pulses greater than 150 ns, do not disable this property. |
![]() | HandshakingInitiation | Gets or sets a value which specifies how to start handshaking with a measurement device. |
![]() | IsScanning | Gets or sets a value which indicates whether the switch has completed the scan operation. The value trueTruetruetrue (True in Visual Basic) indicates that the scan is complete. |
![]() | IsWaitingForTrigger | In a SwitchScan.List, a semicolon (;) is used to indicate that at that point in the SwitchScan.List, the scan engine should pause until a trigger is received from the SwitchScan.TriggerInput. If that trigger is user generated through either a hardware pulse or the SwitchScan.SendSoftwareTrigger method, it is necessary for the user to know when the scan engine has reached such a state. |
![]() | List |
This property contains a SwitchScan.List, which is a string that specifies channel connections and trigger conditions. The SwitchScan.Initiate function makes or breaks connections and waits for triggers according to the instructions in the SwitchScan.List.
The SwitchScan.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.
|
![]() | Mode | Specifies what happens to existing connections that conflict with the connections you make in a SwitchScan.List. For example, if CH1 is already connected to CH2 and the SwitchScan.List instructs the switch to connect CH1 to CH3, this attribute specifies what happens to the connection between CH1 and CH2. If the value of this attribute is SwitchScanMode.None, the switch takes no action on existing paths. If the value is SwitchScanMode.BreakBeforeMake, the switch breaks conflicting paths before making new ones. If the value is SwitchScanMode.BreakBeforeMake, the switch breaks conflicting paths after making new ones. Most switches support only one of the possible values. In such cases, this attribute serves as an indicator of the device's behavior. |
![]() | TriggerInput | Gets or sets a value which specifies the source of the trigger for which the switch can wait when processing a SwitchScan.List. The switch waits for a trigger when it encounters a semicolon in a SwitchScan.List. When the trigger occurs, the switch advances to the next entry in the SwitchScan.List. |
![]() | TriggerInputPolarity | Gets or sets a value which determines the behavior of the trigger input. |