Ivi.Swtch.Interop

IVI Swtch class-compliant root level interface

Opens the I/O session to the instrument. Driver methods and properties that access the instrument are only accessible after Initialize is called. Initialize optionally performs a Reset and queries the instrument to validate the instrument model.

An IVI logical name or an instrument specific string that identifies the address of the instrument, such as a VISA resource descriptor string. Specifies whether to verify the ID of the instrument. Specifies whether to reset the instrument. The user can use the OptionsString parameter to specify the initial values of certain IVI inherent attributes for the session. The format of an assignment in the OptionsString parameter is "Name=Value", where Name is one of: RangeCheck, QuerytInstrStatus, Cache, Simulate, RecordCoercions, InterchangeCheck, or DriverSetup. Value is either true or false except for DriverSetup. If the Options String parameter contains an assignment for the Driver Setup attribute, the Initialize function assumes that everything following "DriverSetup=" is part of the assignment.

Closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called.

Pointer to the IIviDriverOperation interface

Pointer to the IIviDriverIdentity interface

Pointer to the IIviDriverUtility interface

Initialized is True between a successful call to the Initialize method and a successful call to the Close method, and False at all other times.

Pointer to the class-compliant IIviSwtchChannels interface

Pointer to the class-compliant IIviSwtchPath interface

Pointer to the class-compliant IIviSwtchScan interface

IVI Swtch class-compliant channel collection interface

An interface reference pointer to one of the IVI Swtch Channel interfaces which is selected by the channel name.

An interface reference pointer to one of the IVI Swtch Channel interfaces which is selected by the channel name.

The name of a channel. It may be either a name returned by the Name property or a name mapped to a particular repeated capability in the session in the configuration store.

Gets a pointer to a channel object.

The name of a channel. It may be either a name returned by get_Name or a name mapped to a particular repeated capability in the session in the configuration store. A pointer to a class-compliant IIviSwtchChannel interface.

The number of channels.

The channel name for a given index.

The channel name for a given index.

One based index into the collection of channels.

Gets the name of a channel.

One based index into the collection of channels. The string associated by the driver to the value of Index without ever referring to the configuration store.

IVI Swtch class-compliant channel interface

If True, the specific driver can use the channel for internal path creation. The only operations that may be performed on configuration channels are reading and writing the IsConfigurationChannel property.

If True, the channel is a source channel. Two channels that are either sources or have their own connections to sources, may not be connected. This prevents connections that might cause damage to channels, devices, or system.

Pointer to the class-compliant IIviSwtchCharacteristics interface

IVI Swtch class-compliant channel characteristics interface

The maximum AC current the channel can carry, in amperes.

The maximum AC current the channel can switch, in amperes.

The maximum AC power the channel can handle, in volt-amperes.

The maximum AC power the channel can switch, in volt-amperes.

The maximum AC voltage the channel can handle, in volts RMS.

The bandwidth, in Hertz, for the channel.

The maximum DC current the channel can carry, in amperes.

The maximum DC current the channel can switch, in amperes.

The maximum DC power the channel can handle, in watts.

The maximum DC power the channel can switch, in watts.

The maximum DC voltage the channel can handle, in volts.

The characteristic impedance of the channel, in ohms.

The maximum total settling time, in seconds, for the channel before the signal going through it is considered stable. This includes both the activation time for the channel as well as any debounce time.

The number of conductors in the current channel.

IVI Swtch class-compliant path interface

Without actually creating the path, reports whether the switch module can create a given path. This method takes existing paths into account.

A string indicating one of the channels of the path. A string indicating one of the channels of the path. Indicates whether a path is valid and/or possible. See below for definitions.

Creates a path between the two channels. If the path already exists, the operation does not count the number of calls. All paths are assumed to be bi-directional.

A string indicating one of the channels of the path. A string indicating one of the channels of the path.

Destroys the path between the two channels. The order of the two channels need not be the same as the connect operation.

A string indicating one of the channels of the path. A string indicating one of the channels of the path.

Disconnect all paths created since Initialize or Reset have been called. If any paths remain, this method returns a Path Remains warning.

Returns the list of comma separated channel pairs that have been connected in order to create the path between the specified channels. The only valid paths that can be returned are ones that have been explicitly set via Connect and SetPath methods.

A string indicating one of the channels of the path. A string indicating one of the channels of the path. A user-allocated (for IVI-C) or driver-allocated (for IVI-COM) buffer into which the driver stores the list of configuration channels used to create a path between the two channels. The caller may pass VI_NULL for this parameter if the PathListBufferSize parameter is 0.

Creates a path given a PathList of comma separated channel pairs. The end channels are the first and last entries in the PathList. For intermediate channels, the second channel of one pair must be the same as the first channel of the following pair.

List of comma separated channel pairs indicating the path.

Wait until all the signals flowing through the switch have settled. If the signals do not settle within MaxTime, the method returns a Max Time Exceeded error.

Maximum time (in milliseconds).

If True, the switch module has settled from previous switching commands and completed debounce. This indicates that the signal going through the switch module is valid, assuming that the switches in the path have the correct characteristics.

IVI Swtch class-compliant scan interface

Configures the scan List and Mode properties.

Scan list string. The driver uses this value to set the Scan List attribute. See the attribute description for more details. Scanning mode. The driver uses this value to set the Scan Mode attribute. See the attribute description for more details.

Configures the scan Delay, Input trigger, and AdvancedOutput trigger properties, in order to set the trigger behavior for the scan list established with the ConfigureList method.

The minimum length of time you want the instrument to wait from the time the instrument creates a path until it asserts a trigger on the Scan Advanced output line (in seconds). The driver uses this value to set the Scan Delay attribute. See the attribute description for more details. Trigger input. The driver uses this value to set the Trigger Input attribute. See the attribute description for more details. Scan advanced output. The driver uses this value to set the Scan Advanced Output attribute. See the attribute description for more details.

Initiates the scan based on the current List property, and returns once the scan has begun. To stop scanning, call Abort. When the switch is scanning, operations other than reading properties, SendSoftwareTrigger and Abort are invalid.

Stops the scan begun with Initiate method and returns the switch to the Idle state. This operation does not reset or initialize the state of the switch. To determine the status of the scan, call the IsScanning method.

Sends a software trigger, which causes the switch to advance to the next entry in the scan List.

Waits, up to MaxTime milliseconds, for the instrument to stop scanning through the scan List.

Maximum time (milliseconds)

If True, the switch module is currently scanning through the scan list.

If True, the switch module should scan continuously through the scan list, otherwise it should only scan once through the scan list.

The maximum number of channels on the column of a matrix or scanner. If the switch module is a scanner, this value is the number of input channels. The number returned is dependent on the WireMode property.

The maximum number of channels on the row of a matrix or scanner. If the switch module is a scanner, this value is the number of output channels (commons). The number returned is dependent on the WireMode property.

The destination of the scan's advanced output trigger. This trigger is asserted each time a path is created.

The minimum length of time, in milliseconds, from creating the path to asserting the scan's advanced output trigger. The actual time may be longer.

The source of the trigger input. Input triggers tell the switch module to advance to the next entry in the scan list and close the specified channel.

A list of the channels to scan, and the order to scan them in. The format of this string is described in the IviSwtch specification.

The connection breaking behavior of the switch during a scan. Previous paths may be broken before making new ones, after making new ones, or not broken at all.

IVI Swtch class-compliant values for PathCapability

The driver can create a path at this time.

The explicit path between the channels already exists.

The instrument is not capable of creating a path between the two channels.The instrument is not capable of creating a path between the two channels.Although the path is valid, the driver cannot create the path at this moment because the switch module is currently using one or more of the required channels to create another path. You must destroy the other path before creating this one.

Although the path is valid, the driver cannot create the path at this moment because the switch module is currently using one or more of the required channels to create another path. You must destroy the other path before creating this one.

The instrument cannot create a path between the two channels because both are connected to a different source channel.

The driver cannot create a path between the two channels because one of the channels is a configuration channel and thus unavailable for external connections.

IVI Swtch class-compliant values for Scan Mode

Indicates that no action should be taken on the previous paths.

Tells the card to break the previous paths before making the new paths.

Tells the driver to make new paths before breaking the previous paths.

IVI Swtch class-compliant values for Trigger Input

Indicates that the switch module does not wait for a trigger before starting the next entry in the scan list. This is typically done for switch modules that support the Scan Delay attribute and can therefore have the switch module pace itself.

Means the trigger is coming from an external source through a trigger input connection.

The switch exits the Wait-For-Trigger state when the Send Software Trigger function executes. Refer to the Standardized Cross Class Capabilities specification for a complete description of this value and the Send Software Trigger function

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL0.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL1.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL2.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL3.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL4.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL5.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL6.

The switch exits the Wait-For-Trigger state when it receives a trigger on TTL7.

The switch exits the Wait-For-Trigger state when it receives a trigger on ECL0.

The switch exits the Wait-For-Trigger state when it receives a trigger on ECL1.

The switch exits the Wait-For-Trigger state when it receives a trigger on PXI Star trigger bus.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI0.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI1.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI2.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI3.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI4.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI5.

The switch exits the Wait-For-Trigger state when it receives a trigger on RTSI6.

IVI Swtch class-compliant values for scan Advanced Output

No scan advanced output trigger is sent out of the switch module.

Means the trigger is going out to an external device through a trigger output connection.

The scan advanced output trigger is represented as a GPIB SRQ event.

The switch asserts TTL0 each time a path is created.

The switch asserts TTL1 each time a path is created.

The switch asserts TTL2 each time a path is created.

The switch asserts TTL3 each time a path is created.

The switch asserts TTL4 each time a path is created.

The switch asserts TTL5 each time a path is created.

The switch asserts TTL6 each time a path is created.

The switch asserts TTL7 each time a path is created.

The switch asserts ECL0 each time a path is created.

The switch asserts ECL1 each time a path is created.

The switch asserts PXI Star each time a path is created.

The switch asserts RTSI0 each time a path is created.

The switch asserts RTSI1 each time a path is created.

The switch asserts RTSI2 each time a path is created.

The switch asserts RTSI3 each time a path is created.

The switch asserts RTSI4 each time a path is created.

The switch asserts RTSI5 each time a path is created.

The switch asserts RTSI6 each time a path is created.

IVI Swtch class defined HRESULTS

The trigger source is not set to software trigger.

Invalid path list string.

The given scan list string does not have the correct syntax.

One of the channels in the path is a configuration channel that is in use.

No scan list specified.

The specified path list string is empty.

The switch module is currently scanning through the scan list.

The switch module is not currently scanning through the scan list.

No explicit path exists between the channels.

An explicit connection to a configuration channel is not allowed.

One of the non-terminal channels in the path is not a configuration channel.

A connection between two different sources is not allowed.

An explicit connection between the channels already exists.

A leg in the path does not begin with a channel name.

A leg in the path is missing the second channel.

The first and the second channels in the leg are the same.

A channel name is duplicated in the path string.

No path was found between the two channels.

The first channel of a leg in the path is not the same as the second channel in the previous leg.

The path contains a leg with two channels that cannot be directly connected.

A leg in the path contains two channels that are already directly connected.

A channel cannot be connected to itself.

Maximum time exceeded before the operation completed.

Some connections remain after disconnecting.

The implicit connection exists between the channels.