SwitchScan Methods
- Updated2023-02-21
- 4 minute(s) read
The SwitchScan type exposes the following members.
Methods
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. |