Ivi.SpecAn.Interop IVI SpecAn 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 IIviSpecAnFrequency interface Pointer to the class-compliant IIviSpecAnSweepCoupling interface Pointer to the class-compliant IIviSpecAnLevel interface Pointer to the class-compliant IIviSpecAnAcquisition interface Pointer to the class-compliant IIviSpecAnDisplay interface Pointer to the class-compliant IIviSpecAnExternalMixer interface Pointer to the class-compliant IIviSpecAnTrigger interface Pointer to the class-compliant IIviSpecAnTraces interface Pointer to the class-compliant IIviSpecAnMarker interface Pointer to the class-compliant IIviSpecAnPreselector interface IVI SpecAn class-compliant frequency interface This function configures the frequency range of the IviSpecAn using the center frequency and frequency span. If span corresponds to zero hertz, then the spectrum analyzer is in time-domain. This function modifies the Frequency Start and Frequency Stop attributes as follows: Frequency Start = center frequency - span/2 and Frequency Stop = center frequency + span/2. In auto-coupled mode, RBW, VBW and sweep time may be affected by this function. The center frequency of the frequency sweep (in Hertz). The frequency span of the frequency sweep (in Hertz). This function configures the frequency range of the IviSpecAn using start frequency and stop frequency. If start frequency is equal to the stop frequency, then the spectrum analyzer is in time-domain mode. In auto-coupled mode, resolution bandwidth (RBW), video bandwidth (VBW), and sweep time may be affected by this function. Specifies the left edge of frequency domain in Hertz. Specifies the right edge of frequency domain in Hertz. Specifies the left edge of frequency domain in Hertz. Specifies the right edge of frequency domain in Hertz. Specifies an offset that is added to the frequency readout to account for external frequency conversion. IVI SpecAn class-compliant sweep coupling interface This function configures the coupling and sweeping attributes of the IviSpecAn. Turns resolution bandwidth auto coupling on/off. The driver uses this value to set the Resolution Bandwidth Auto attribute. See the attribute description for more details. Specifies the measurement resolution bandwidth in Hertz. This value is ignored when ResolutionBandwidthAuto is True. The driver uses this value to set the Resolution Bandwidth attribute. See the attribute description for more details. Turns video bandwidth auto coupling on/off. The driver uses this value to set the Video Bandwidth Auto attribute. See the attribute description for more details. Specifies the video bandwidth of the post-detection filter in Hertz. This value is ignored when VideoBandwidthAuto is True. The driver uses this value to set the Video Bandwidth attribute. See the attribute description for more details. Turns sweep time coupling on/off. The driver uses this value to set the Sweep Time Auto attribute. See the attribute description for more details. Specifies the length of time (in seconds) to sweep from the beginning to the end of the current domain. Turns resolution bandwith auto coupling on/off. Specifies the width of the IF filter in Hertz. Turns video bandwith auto coupling on/off. Specifies the video bandwidth of the post-detection filter in Hertz. Turns sweep time auto coupling on/off. Specifies the length of time (in seconds) to sweep from the beginning to the end of the current domain. IVI SpecAn class-compliant level interface This function configures the vertical attributes of the IviSpecAn. Specifies the amplitude units for input, output and display. The driver uses this value to set the Amplitude Units attribute. See the attribute description for more details. Specifies the input impedance. The driver uses this value to set the Input Impedance attribute. See the attribute description for more details. Specifies the amplitude value of the reference level. The driver uses this value to set the Reference Level attribute. See the attribute description for more details. Specifies the offset value to the reference level. The driver uses this value to set the Reference Level Offset attribute. See the attribute description for more details. Turns auto attenuation on/off. The driver uses this value to set the Attenuation Auto attribute. See the attribute description for more details. Specifies the attenuation level. If AttenuationAuto is True then this parameter is ignored. The driver uses this value to set the Attenuation attribute. See the attribute description for more details. Specifies the amplitude units for input, output and display amplitude. Specifies the value of input impedance expected at the active input port. Specifies the reference level. Adds an offset to the displayed reference level. Turns attenuation aut on/off. Specifies the input attenuation (in positive dB). IVI SpecAn class-compliant acquisition interface This function configures the acquisition attributes of the IviSpecAn. Turns on/off continuous sweeping. The driver uses this value to set the Sweep Mode Continuous attribute. See the attribute description for more details. The number of sweeps to take. The driver uses this value to set the Number Of Sweeps attribute. See the attribute description for more details. Turns auto detector on/off. The driver uses this value to set the Detector Type Auto attribute. See the attribute description for more details. Specifies the method of capturing and processing signal data. The driver uses this value to set the Detector Type attribute. See the attribute description for more details. Specifies the vertical scale. The driver uses this value to set the Vertical Scale attribute. See the attribute description for more details. Turns continuous sweep on/off. Specifies the number of sweeps. Turns automatic selection of detector type on/off. Specifies the detector type used to capture and process the signal. Specifies the vertical scale of the measurement hardware (use of log amplifiers vs. linear amplifiers). IVI SpecAn class-compliant display interface Specifies the number of vertical units in one screen division. Specifies the number of vertical screen divisions. IVI SpecAn class-compliant external mixer interface This function specifies the mixer harmonic number and average conversion loss. Specifies harmonic number. The driver uses this value to set the External Mixer Harmonic attribute. See the attribute description for more details. Specifies the average conversion loss. The driver uses this value to set the External Mixer Average Conversion Loss attribute. See the attribute description for more details. Pointer to the class-compliant IIviSpecAnExternalMixerBias interface Pointer to the class-compliant IIviSpecAnExternalMixerConversionLossTable interface Specifies the harmonic number. Specifies the average conversion loss. Specifies whether the external mixer is enabled. Specifies a two-port mixer or a three-port mixer. IVI SpecAn class-compliant external mixer bias interface This function configures the external mixer bias and the external mixer bias limit. Specifies the bias current. The driver uses this value to set the External Mixer Bias attribute. See the attribute description for more details. Specifies the bias current limit. The driver uses this value to set the External Mixer Bias Limit attribute. See the attribute description for more details. Specifies the bias current in amps. Specifies the bias current limit. Turns bias on/off. IVI SpecAn class-compliant external mixer conversion loss table interface This function configures the conversion loss table by specifying a frequency and a power loss pair. Specifies the frequency for the given count. Specifies the conversion loss for the given count. Turns the external mixer conversion loss table on/off. IVI SpecAn class-compliant trigger interface Specifies the source for the trigger signal that causes the analyzer to leave the Wait-For-Trigger state. Pointer to the class-compliant IIviSpecAnTriggerExternal interface Pointer to the class-compliant IIviSpecAnTriggerVideo interface IVI SpecAn class-compliant trigger external interface This function specifies the external level and slope for triggering. Specifies the external level for triggering. The driver uses this value to set the External Trigger Level attribute. See the attribute description for more details. Specifies the external slope for triggering. The driver uses this value to set the External Trigger Slope attribute. See the attribute description for more details. Specifies the external level for triggering in volts. Specifies the external trigger slope. IVI SpecAn class-compliant trigger video interface This function specifies the video level and slope for triggering. Specifies the video level for triggering. The driver uses this value to set the Video Trigger Level attribute. See the attribute description for more details. Specifies the video level slope for triggering. The driver uses this value to set the Video Trigger Slope attribute. See the attribute description for more details. Specifies the video level for triggering in the units specified by the Amplitude Units attribute. Specifies the video trigger slope. IVI SpecAn class-compliant trace collection interface This function aborts a previously initiated measurement. This function initiates an acquisition. This function determines if an acquisition is in progress or complete. Acquisition Status This function generates a software trigger. Pointer to the class-compliant IIviSpecAnTracesMath interface Returns an interface reference pointer to an IIviSpecAnTrace interface. Returns an interface reference pointer to an IIviSpecAnTrace interface. The name of a trace. 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 trace object. The name of a trace. 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 IIviSpecAnTrace interface. Returns the number of traces. Returns the trace name for a given index. Returns the trace name for a given index. One based index into the collection of traces. Gets the name of a trace. One based index into the collection of traces. The string associated by the driver to the value of Index without ever referring to the configuration store. IVI SpecAn class-compliant traces math interface This function adds Trace 1 and Trace 2 and stores the result in the Destination Trace. Name of the trace into which the added traces are stored. Name of one of the two traces to be added. Name of the second trace to be added. This function copies one trace array to another trace array. Name of the trace into which the array is stored. Name of the trace to be copied. This function exchanges the data arrays of two traces. Name of one of the two traces to be exchanged. Name of the second trace to be exchanged. This function subtracts the array elements of Trace 2 from Trace 1 and stores the result in the Destination Trace. Name of the trace into which the subtracted traces are stored. Name of the first trace to be subtracted. Name of the second trace to be subtracted. IVI SpecAn class-compliant trace interface This function returns the trace the spectrum analyzer aquires. The array which contains the trace amplitudes. This function initiates a signal acquisition, waits for the completion, and returns the trace as amplitude array. Specifies the maximum time the end-user allows for this method to complete in milliseconds. The values defined in IviSpecAnMaxTimeEnum are also allowed. The array which contains the trace amplitudes. Returns the number of points in the trace array. Specifies the representation of the aquired data. IVI SpecAn class-compliant marker interface This function enables/disables the active marker on the specified trace. Turns the active marker on/off. The driver uses this value to set the Marker Enabled attribute. See the attribute description for more details. Specifies the trace name. The driver uses this value to set the Marker Trace attribute. See the attribute description for more details. This function configures the marker peak excursion and marker threshold attribute values. Minimum amplitude below which a peak will not be found. The driver uses this value to set the Marker Threshold attribute. See the attribute description for more details. Minimum amplitude variation of the signal that the marker can recognize as a peak in dB. The driver uses this value to set the Peak Excursion attribute. See the attribute description for more details. This function turns off all the markers. This function specifies whether the active marker is a delta marker. Turns delta marker on/off. The driver uses this value to set the Marker Type attribute. See the attribute description for more details. This function specifies the type of marker search and performs the search. Specifies the type of marker search. This function returns the horizontal position and the marker amplitude level of the Active Marker. The horizontal position of the active marker. The amplitude value of the Active Marker (Amplitude Units or relative amplitude units for delta markers). This function returns the horizontal position and the marker amplitude level of the reference marker when the active marker is a delta marker. Returns the reference marker position value when the active marker is a delta marker. Returns the reference marker amplitude value when the active marker is a delta marker. This function makes the Active Marker frequency to be the start, stop, or center frequency. It can also make the active marker amplitude to be the reference level. Specifies the instrument setting to be set from the marker position. Pointer to the class-compliant IIviSpecAnMarkerFrequencyCounter interface Establishes the active marker. Returns the amplitude of the active marker. Enables/disables the active marker. Specifies the marker type of the active marker. Specifies the number of markers available for a particular instrument. Returns the marker name for a given index. Gets the name of a marker. One based index into the collection of markers. The string associated by the driver to the value of Index without ever referring to the configuration store. Specifies the minimum amplitude variation of the signal in dB that the marker can identify as a peak. Specifies the frequency or time position of the active marker. Returns the reference marker position when the active marker is a delta marker. Returns the reference marker amplitude when the active marker is a delta marker. Enables/disables signal tracking. Specifies the lower limit for the marker search functions. Specifies the trace for the active marker. IVI SpecAn class-compliant marker frequency counter interface This function sets the marker frequency counter resolution and turns the marker frequency counter on/off. Turns marker frequency counter on/off. The driver uses this value to set the Marker Frequency Counter Enabled attribute. See the attribute description for more details. Specifies the frequency counter resolution in hertz. This value is ignored when markerFrequencyCounter is False. This value is restricted to a power of ten. An attempt to set this to other than a power of ten results in an error without the value being changed. The driver uses this value to set the Marker Frequency Counter Resolution attribute. See the attribute description for more details. This function activates/deactivates the marker counter. Specifies the resolution of the frequency counter in Hertz. IVI SpecAn class-compliant preselector interface This function adjusts the preselector to obtain the maximum readings for the current start and stop frequency. IVI SpecAn class-compliant values for Amplitude Units Sets the spectrum analyzer to measure in decibels relative to 1 milliwatt. Sets the spectrum analyzer to measure in decibels relative to 1 millivolt. Sets the spectrum analyzer to measure in decibels relative to 1 microvolt. Sets the spectrum analyzer to measure in volts. Sets the spectrum analyzer to measure in watts. IVI SpecAn class-compliant values for Detector Type Allows the detector to capture better readings by using both positive and negative peak values when noise is present. Average value of samples taken within the bin for a dedicated point on the display. Obtains the maximum video signal between the last display point and the present display point. Obtains the minimum video signal between the last display point and the present display point. Pick one point within a bin. RMS value of samples taken within the bin for a dedicated point on the display. IVI SpecAn class-compliant values for Vertical Scale Sets the vertical scale in linear units. Sets the vertical scale in logarithmic units. IVI SpecAn class-compliant values for Trigger Source The spectrum analyzer waits until it receives a trigger on the external trigger connector. The spectrum analyzer does not wait for a trigger of any kind. The spectrum analyzer waits until it receives a software triggerl. The spectrum analyzer waits until it receives a trigger on the AC line. The spectrum analyzer waits until it receives a video level. IVI SpecAn class-compliant values for External Trigger Slope Sets positive slope. Sets negative slope. IVI SpecAn class-compliant values for Video Trigger Slope Sets positive slope. Sets negative slope. IVI SpecAn class-compliant values for acquisition status The spectrum analyzer has completed the acquisition. The spectrum analyzer is still acquiring data. The spectrum analyzer cannot determine the status of the acquisition. IVI SpecAn class-compliant values for Trace Type Sets the spectrum analyzer to clear previous sweep data off the display before performing a sweep. Subsequent sweeps may or may not clear the display first, but the data array at the end of the sweep is entirely new. Sets the spectrum analyzer to keep the data from either the previous data or the new sweep data, which ever is higher. Sets the spectrum analyzer to keep the data from either the previous data or the new sweep data, which ever is lower. Sets the spectrum analyzer to maintain a running average of the swept data. Disables acquisition into this trace but displays the existing trace data. Disables acquisition and disables the display of the existing trace data. IVI SpecAn class-compliant values for Marker Type Regular marker used to make absolute measurements. Marker used in conjunction with the reference marker to make relative measurements. IVI SpecAn class-compliant values for Marker Search Sets marker search for the highest amplitude. Sets marker search for the minimum amplitude. Sets marker search for the next highest peak. Sets marker search for the next peak left of the current marker position. Sets marker search for the next peak right of the current marker position. IVI SpecAn class-compliant values for Set Value from Marker Sets the center frequency with the Active Marker frequency. IF the Active Marker is a Delta Marker, this sets the frequency span with the Active Marker frequency and the center frequency at the midpoint between the Active Marker and its reference. Sets the Frequency Start with the Active Marker frequency. Sets the Frequency Stop with the Active Marker frequency. Sets the Reference Level with the Active Marker amplitude. IVI SpecAn class defined HRESULTS The instrument was in an uncalibrated state when the measurement was taken. The measurement taken was over the instrument's range. Trigger source is not software trigger. The Active Marker is not enabled. The Active Marker is not a delta marker. The maximum waiting time for this operation was exceeded. IVI SpecAn class-compliant values for MaxTime Sets timeout to immediate. Sets timeout to infinite.