Ivi.Scope.Interop

IVI Scope class-compliant root 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 IIviScopeAcquisition interface

Pointer to the class-compliant IIviScopeChannels interface

Pointer to the class-compliant IIviScopeMeasurements interface

Pointer to the class-compliant IIviScopeReferenceLevel interface

Pointer to the class-compliant IIviScopeTrigger interface

IVI Scope class-compliant acquisition interface

Configures the most commonly used properties of the oscilloscope's acquisition subsystem: time per record, minimum record length, and the acquisition start time.

Specifies the time per record. This value sets the Horizontal Time Per Record property. Specifies the minimum number of points the end-user allows in the waveform recorded. This value sets the Horizontal Minimum Number of Points property. Specifies the position of the first point in the waveform record relative to the trigger event. This value sets the Acquisition Start Time property.

The number of waveforms the oscilloscope acquires and averages before returning to the idle state.

The number of waveforms the oscilloscope acquires and analyzes to create the minimum and maximum waveforms, before returning to the idle state. Applies only when acquisition Type is Envelope

The interpolation method the oscilloscope uses when it cannot sample a voltage for every point in the waveform record.

The actual number of points the oscilloscope acquires for each channel. It is equal to or greater than the minimum number of points specified with the Horizontal Minimun Number of Points property.

The sample mode the oscilloscope is currently using.

The effective digitizing rate using the current configuration. The units are samples per second.

How the oscilloscope acquires data and fills the waveform record. When set to Envelope or Peak Detect, the oscilloscope acquires minimum and maximum waveforms.

The minimum number of points which can be in a waveform record for each channel. It configures the record length that the oscilloscope uses for waveform acquisition. The Record Length property returns the actual record length.

The length of time from the trigger event to the first point in the waveform record. The units are seconds. If positive, the first point in the waveform occurs after the trigger. If negative, the first point in the waveform occurs before the trigger.

The time in seconds that corresponds to the record length.

IVI Scope class-compliant channel collection interface

An interface reference pointer to one of the IviScopeChannel 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 IIviScopeChannel interface.

The number of channels.

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 Scope class-compliant channel interface

Configures the most commonly used properties of the oscilloscope channel sub-system. They are the range, offset, coupling, probe attenuation, and whether the channel is enabled.

Specifies the vertical range. This value sets the Vertical Range property. Specifies the vertical offset. This value sets the Vertical Offset property. Specifies how to couple the input signal. This value sets the Vertical Specifies the probe attenuation. This value sets the Probe Attenuation property. Specifies if the channel is enabled for acquisition. This value sets the Channel Enabled property.

Configures the properties that control the electrical characteristics of the channel. They are the input impedance and the maximum frequency of the input signal.

The input impedance for the channel. The driver sets the Input Impedance to this value. The maximum input frequency for the channel. The driver sets the Max Input Frequency to this value.

The probe attenuation value the oscilloscope automatically senses. If the automatic probe sense is disabled, its value is the manual probe attenuation setting.

How the oscilloscope couples the input signal.

If True, the oscilloscope acquires a waveform for this channel when the Initiate Acquisition, Read Waveform, Read Min Max Waveform, or Read Waveform Measurement methods are called.

The maximum input frequency of this channel. It the frequency at which the input circuitry attenuates the input signal by 3 dB. The units are hertz.

The input impedance of this channel. The units are ohms.

The location of the center of the range that you specify with the Range property. The units are volts, with respect to ground. For example, to acquire a sine wave spanning 0.0 to 10.0 volts, set Offset to 5.0 volts.

The scaling factor by which the probe attenuates the input signal. For example, with a 10:1 probe, the value is 10.0.

The absolute value of the input range the oscilloscope can acquire for the channel. The units are volts. For example, to acquire a sine wave spanning -5.0 to 5.0 volts, set Range to 10.0 volts.

IVI Scope class-compliant measurement collection interface

Initiates a waveform acquisition. The oscilloscope leaves the Idle state and waits for a trigger. The oscilloscope acquires a waveform for each enabled channel.

Aborts an acquisition and returns the oscilloscope to the Idle state.

Automatically configures all the oscilloscopes settings based on the input signals.

Returns whether an acquisition is in progress, complete, or if the status is unknown.

Acquisition Status. May be one of the values define by IviScopeAcquisitionStatusEnum.

Returns False if an element in a waveform array returned by the driver contains a valid voltage. Returns True if an element in a waveform array returned by the driver contains a value indicating that the oscilloscope could not sample a voltage.

Pass one of the values from the waveform array returned by the read and fetch waveform methods. Returns whether true when the elementValue is a valid voltage or false for a value indicating that the oscilloscope could not sample a voltage.

An interface reference pointer to one of the IviScopeMeasurement 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 measurement object.

The number of measurements.

The measurement name for given index.

One based index into the collection of measurements.

Gets the name of a measurement.

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

IVI Scope class-compliant measurement interface

Returns a previously acquired waveform for this channel. The acquisition must be made prior to calling this method. Call this method separately for each channel.

The array contains the acquired waveform.. Units for the individual array elements are in volts. The time in relation to the Trigger Event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.

Returns a previously acquired waveform measurement for this channel. The acquisition must be made prior to calling this method. Call this method separately for each measurement.

Characteristic of the acquired waveform to be measured. The measured value. The units depend on the measurement that the user specifies with the measFunction parameter.

Returns the previously acquired minimum and maximum waveforms for this specified channel. The acquisition must be made prior to calling this method. Call this method separately for each channel.

This array contains the min waveform. This array contains the max waveform. The time in relation to the Trigger Event of the first point in the waveform in seconds. The time between points in the acquired waveform in seconds.

Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the waveform for this channel. Call FetchWaveform to obtain the waveforms for other channels.

Specifies the maximum time the end-user allows for this method to complete in milliseconds. The values defined in IviScopeTimeOutEnum are also allowed. The array contains the acquired waveform.. Units for the individual array elements are in volts. The time in relation to the Trigger Event of the first point in the waveform in seconds. Negative values mean that the first point in the waveform array was acquired before the trigger event. The effective time between points in the acquired waveform in seconds.

Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the measurement for this channel. Call FetchWaveformMeasurement to obtain other measurements for this or other channels.

Characteristic of the acquired waveform to be measured. Specifies the maximum time the end-user allows for this method to complete in milliseconds. The values defined in IviScopeTimeOutEnum are also allowed. The measured value. The units depend on the measurement that the user specifies with the measFunction parameter.

Initiates an acquisition on all enabled channels, waits (up to MaxTime) for the acquisition to complete, and returns the min/max waveforms for this channel. Call FetchMinMaxWaveform to obtain the min/max waveforms for other channels.

Specifies the maximum time the end-user allows for this method to complete in milliseconds. The values defined in IviScopeTimeOutEnum are also allowed. This array contains the min waveform. This array contains the max waveform. The time in relation to the Trigger Event of the first point in the waveform in seconds. The time between points in the acquired waveform in seconds.

IVI Scope class-compliant reference level interface

Configures the reference levels for waveform measurements, low, mid, and high.

Measurement low reference. This value sets the Meas Low Ref property Measurement mid reference. This value sets the Meas Mid Ref property. Measurement high reference. This value sets the Meas High Ref property.

The high reference for waveform measurements. It is a percentage of the difference between the Voltage High and Voltage Low. Voltage High and Voltage Low may be calculated using either the min/max or histogram methods.

The low reference for waveform measurements. It is a percentage of the difference between the Voltage High and Voltage Low. Voltage High and Voltage Low may be calculated using either the min/max or histogram methods.

The mid reference for waveform measurements. It is a percentage of the difference between the Voltage High and Voltage Low. Voltage High and Voltage Low may be calculated using either the min/max or histogram methods.

IVI Scope class-compliant trigger interface

Configures trigger Type and Holdoff. Holdoff units are seconds.

Specifies the trigger type. This value sets the Trigger Type property. Specifies the trigger hold-off. This value sets the Trigger Holdoff property.

If True, the oscilloscope waits trigger holdoff seconds after a waveform acquisition is complete and then immediatley enters the wait for trigger state without passing through the idle state.

How the oscilloscope couples the trigger source.

The voltage threshold for the trigger subsystem. The units are volts.

The trigger modifier determines the oscilloscope's behavior in the absence of a trigger.

The signal the oscilloscope monitors for a trigger. It can be channel or one of many other values.

The length of time the oscilloscope waits after it fills the acquisition buffer until the oscilloscope enables the trigger subsystem to detect another trigger. The units are seconds.

The kind of event that triggers the osciolloscope.

Pointer to the class-compliant IIviScopeTriggerAcLine interface

Pointer to the class-compliant IIviScopeTriggerEdge interface

Pointer to the class-compliant IIviScopeTriggerGlitch interface

Pointer to the class-compliant IIviScopeTriggerRunt interface

Pointer to the class-compliant IIviScopeTriggerTv interface

Pointer to the class-compliant IIviScopeTriggerWidth interface

IVI Scope class-compliant AC line trigger interface

The slope of the zero crossing upon which the scope triggers.

IVI Scope class-compliant edge trigger interface

Configures the conidtions for edge trigger. An edge trigger occurs when the trigger source signal passes through the trigger level with the specified slope.

Specifies the trigger source. This value sets the Trigger Source property. Specifies the trigger level. This value sets the Trigger Level property. Specifies the trigger slope. This value sets the Trigger Slope property.

The slope, a rising or a falling edge, that triggers the oscilloscope.

IVI Scope class-compliant glitch trigger interface

Configure the glitch trigger Source, Level, Width, Polarity, and Condition. A glitch trigger occurs when the edge of a pulse that matches the Width and Polarity crosses the specified Level (in Volts).

Specifies the trigger source. This value sets the Trigger Source property. Specifies the trigger level. This value sets the Trigger Level property. Specifies the glitch triggering glitch width in seconds. This value sets the Glitch Width property. Specifies the glitch polarity. This value sets the Glitch Polarity property. Specifies the glitch condition. This value sets the Glitch Condition property.

The glitch condition detemermines whether the oscilloscope triggers on a a pulse with a width less than or greater than the glitch width value.

The polarity of the glitch that triggers the oscilloscope.

The glitch width. The units are seconds.

IVI Scope class-compliant runt trigger interface

Configures the runt trigger Source, ThresholdLow, ThresholdHigh, and Polarity. A runt trigger occurs when the trigger signal crosses one of the runt thresholds twice without crossing the other runt threshold.

Specifies the trigger source. This value sets the Trigger Source property. Sets the runt triggering low threshold in volts. Sets the runt triggering high threshold in volts. Sets the runt polarity.

The polarity of the runt that triggers the oscilloscope.

The high threshold the oscilloscope uses for runt triggering. The units are volts.

The low threshold the oscilloscope uses for runt triggering. The units are volts.

IVI Scope class-compliant TV trigger interface

Configures the TV trigger source, signal format, event and polarity.

Specifies the trigger source. This value sets the Trigger Source property. Specifies the TV trigger signal format. This value sets the TV Trigger Signal Format property. Specifies the TV trigger event. This value sets the TV Trigger Event property. Specifies the polarity of the TV trigger. This value sets the TV Trigger Polarity property.

The line on which the oscilloscope triggers. The line number is absolute and not relative to the field of the TV signal.

The event on which the oscilloscope triggers.

The polarity of the TV signal.

The format of the TV signal on which the oscilloscope triggers.

IVI Scope class-compliant width trigger interface

Configures the width trigger Source, Level, ThresholdLow, ThresholdHigh, Polarity, and Condition. A width trigger occurs when a pulse, that passes through Level, with a width between or outside, the width thresholds is detected.

Trigger Level. This value sets the Trigger Level property. Sets the width triggering low threshold in seconds. This value sets the Width Low Threshold property. Sets the width triggering high threshold in seconds. This value sets the Width High Threshold property. Sets the width polarity. This value sets the Width Polarity property. Specifies whether a pulse that is within or outside the user-specified thresholds trigger waveform acquisition. This value sets the Width Condition property.

The condition of a pulse that triggers the oscilloscope. The condition is either inside or outside of the high and low thresholds.

The polarity of the pulse that triggers the oscilloscope.

The low width threshold time. The units are seconds.

The high width threshold time. The units are seconds.

IVI Scope class-compliant values for acquisition Interpolation

The oscilloscope does not interpolate points in the waveform. Instead, the driver sets every element in the waveform record for which the oscilloscope cannot receive a value to an IEEE-defined NaN (Not-a-Number) value. Use the Is Waveform Element Invalid method to determine if the waveform record element is invalid.

The oscilloscope uses a sin(x)/x calculation to interpolate a value when it cannot resolve a voltage in the waveform record.

The oscilloscope uses a linear approximation to interpolate a value when it cannot resolve a voltage in the waveform record.

IVI Scope class-compliant values for acquisition SampleMode

Indicates that the oscilloscope is using real-time sampling.

Indicates that the oscilloscope is using equivalent time sampling.

IVI Scope class-compliant values for Acquisition Type

Configures the oscilloscope to acquire one sample for each point in the waveform record. The oscilloscope uses real-time or equivalent time sampling.

Sets the oscilloscope to the peak-detect acquisition mode. The oscilloscope oversamples the input signal and keeps the minimum and maximum values that correspond to each position in the waveform record. The oscilloscope uses only real-time sampling.

Configures the oscilloscope to oversample the input signal. The oscilloscope calculates the average value that corresponds to each position in the waveform record. The oscilloscope uses only real-time sampling.

Sets the oscilloscope to the envelope acquisition mode. The oscilloscope acquires multiple waveforms and keeps the minimum and maximum voltages it acquires for each point in the waveform record. The end-user specifies the number of waveforms the oscilloscope acquires with the Number of Envelopes property. The oscilloscope can use real-time or equivalent-time sampling.

Configures the oscilloscope to acquire multiple waveforms and calculate the average value for each point in the waveform record. The end-user specifies the number of waveforms to acquire with the Number of Averages property. The oscilloscope uses real-time or equivalent time sampling.

IVI Scope class-compliant values for channel Coupling

The oscilloscope AC couples the input signal.

The oscilloscope DC couples the input signal.

The oscilloscope couples the channel to the ground.

IVI Scope class-compliant values for the MeasFunction parameter of the measurement Read and Fetch methods

The length of time for a rising edge of the signal to rise from the low reference level to the high reference level. The units are seconds.

The length of time for a falling edge of the signal to fall from the high reference level to the low reference level. The units are seconds.

The frequency of one complete cycle in the waveform. The units are Hertz.

The length of time of one complete cycle in the waveform. The units are seconds.

The true Root Mean Square voltage of the entire waveform. The units are Volts.

The absolute difference between the Voltage Max and the Voltage Min. The units are Volts.

The maximum amplitude found in the entire waveform. The units are Volts.

The minimum amplitude found in the entire waveform. The units are Volts.

The voltage that corresponds to 100% when using the reference levels. The oscilloscope calculates this value using either the min/max or histogram methods. The min/max method uses the maximum value found. The histogram method uses a common value found above the middle of the waveform. The units are Volts.

The voltage that corresponds to 0% when using the reference levels. The oscilloscope calculates this value using either the min/max or histogram methods. The min/max method uses the minimum value found. The histogram method uses a common value found below the middle of the waveform. The units are Volts.

The arithmetic average in volts measured over the entire waveform. The units are Volts.

The length of time between the mid reference level points of a negative pulse in the waveform. The units are seconds.

The length of time between the mid reference level points of a positive pulse in the waveform. The units are seconds.

The ratio of the Width Neg to the Period of an integer number of cycles in the waveform expressed as a percentage.

The ratio of the Width Pos width to the Period of an integer number of cycles in the waveform expressed as a percentage.

The Voltage High less the Voltage Low in Volts over the entire waveform.

The true Root Mean Square voltage over an integer number of cycles in the waveform. The units are Volts.

The arithmetic average in Volts over an integer number of cycles in the waveform. The units are Volts.

The relative waveform distortion that follows an edge transition.

The relative waveform distortion that precedes an edge transition.

IVI Scope class-compliant values for the status parameter of the acquisition Status method

The oscilloscope has completed the acquisition.

The oscilloscope is still acquiring data.

The oscilloscope cannot determine the status of the acquisition.

IVI Scope class-compliant values for trigger Type

Configures the oscilloscope for edge triggering. An edge trigger occurs when the trigger signal specified with the Trigger Source property passes the voltage threshold specified with the Trigger Level property and has the slope specified with the Trigger Slope property.

Configures the oscilloscope for width triggering. Use the IviScopeWidthTrigger extension properties and methods to configure the trigger.

Configures the oscilloscope for runt triggering. Use the IviScopeRuntTrigger extension properties and methods to configure the trigger.

Configures the oscilloscope for glitch triggering. Use the IviScopeGlitchTrigger extension properties and methods to configure the trigger.

Configures the oscilloscope for triggering on TV signals. Use the IviScopeTVTrigger extension properties and methods to configure the trigger.

Configures the oscilloscope for immediate triggering. The oscilloscope does not wait for trigger of any kind upon initialization.

Configures the oscilloscope for AC Line triggering. Use the IviScopeACLineTrigger extension properties and methods to configure the trigger.

IVI Scope class-compliant values for trigger Coupling

The oscilloscope AC couples the trigger signal.

The oscilloscope DC couples the trigger signal.

The oscilloscope filters out the high frequencies from the trigger signal.

The oscilloscope filters out the low frequencies from the trigger signal.

The oscilloscope filters out the noise from the trigger signal.

IVI Scope class-compliant values for trigger Modifier

The oscilloscope waits until the trigger the end-user specifies occurs.

The oscilloscope automatically triggers if the configured trigger does not occur within the oscilloscope's timeout period.

The oscilloscope adjusts the trigger level if the trigger the end-user specifies does not occur.

IVI Scope class-compliant values for AC line trigger Slope

Configures the oscilloscope to trigger on positive slope zero crossings of the network supply voltage.

Configures the oscilloscope to trigger on negative slope zero crossings of the network supply voltage.

Configures the oscilloscope to trigger on either positive or negative slope zero crossings of the network supply voltage.

IVI Scope class-compliant values for edge trigger Slope

A positive (rising) edge passing through the trigger level triggers the oscilloscope.

A negative (falling) edge passing through the trigger level triggers the oscilloscope.

IVI Scope class-compliant values for glitch trigger Polarity

The oscilloscope triggers on a positive glitch.

The oscilloscope triggers on a negative glitch.

The oscilloscope triggers on either a positive or negative glitch.

IVI Scope class-compliant values for glitch trigger Condition

The oscilloscope triggers when the pulse width is less than the value you specify with the Glitch Width property.

The oscilloscope triggers when the pulse width is greater than the value you specify with the Glitch Width property.

IVI Scope class-compliant values for runt trigger Polarity

The oscilloscope triggers on a positive runt. A positive runt occurs when a rising edge crosses the low runt threshold and does not cross the high runt threshold before re-crossing the low runt threshold.

The oscilloscope triggers on a negative runt. A negative runt occurs when a falling edge crosses the high runt threshold and does not cross the low runt threshold before re-crossing the high runt threshold.

The oscilloscope triggers on either a positive or negative runt.

IVI Scope class-compliant values for TV trigger SignalFormat

Configures the oscilloscope to trigger on the NTSC signal format.

Configures the oscilloscope to trigger on the PAL signal format

Configures the oscilloscope to trigger on the SECAM signal format

IVI Scope class-compliant values for TV trigger Event

Sets the oscilloscope to trigger on field 1 of the video signal.

Sets the oscilloscope to trigger on field 2 of the video signal.

Sets the oscilloscope to trigger on any field.

Sets the oscilloscope to trigger on any line.

Sets the oscilloscope to trigger on a specific line number you specify with the TV Trigger Line Number property.

IVI Scope class-compliant values for TV trigger Polarity

Configures the oscilloscope to trigger on a positive video sync pulse.

Configures the oscilloscope to trigger on a negative video sync pulse.

IVI Scope class-compliant values for width trigger Polarity

Configures the oscilloscope to trigger on positive pulses that have a width that meets the condition the user specifies with the Width Condition property.

Configures the oscilloscope to trigger on negative pulses that have a width that meets the condition the user specifies with the Width Condition property.

Configures the oscilloscope to trigger on either positive or negative pulses that have a width that meets the condition the user specifies with the Width Condition property.

IVI Scope class-compliant values for width trigger Condition

Configures the oscilloscope to trigger on pulses that have a width that is less than the high threshold and greater than the low threshold. The end-user specifies the high and low thresholds with the Width High Threshold and Width Low Threshold properties.

Configures the oscilloscope to trigger on pulses that have a width that is either greater than the high threshold or less than a low threshold. The end-user specifies the high and low thresholds with the Width High Threshold and Width Low Threshold properties.

IVI Scope class defined HRESULTS

Specified channel is not enabled.

Unable to perform desired measurement operation.

Maximum time exceeded before the operation completed.

Invalid acquisition type.

One of the elements in the waveform array is invalid.

IVI Scope class-compliant values for maxTime parameter of the measurement Read and Fetch methods.

The method waits indefinitely for the measurement to complete.

The method returns immediately. If no valid measurement value exists, the method returns an error.