Ivi.PwrMeter.Interop

IVI PwrMeter 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.

Reference to the class-compliant IIviPwrMeterChannels interface

Reference to the class-compliant IIviPwrMeterMeasurement interface

Reference to the class-compliant IIviPwrReferenceOscillator interface

Reference to the class-compliant IIviPwrMeterTrigger interface

Class-compliant IIviPwrMeter interface containing methods and properties that apply to all channels in the instrument. A particular channel can be referenced using the Item property

Class-compliant IIviPwrMeter method that queries the instrument to determine the status of all calibration operations

Returns the status of the calibration.

Class-compliant IIviPwrMeter method that queries the instrument to determine the status of all zero operations

Returns the status of the zeroing.

Class-compliant IIviPwrMeter method that performs a zero operation on all enabled channels

Class-compliant IIviPwrMeter property that indicates the number of channels available on the instrument

Class-compliant IIviPwrMeter property that is used to reference a Channel interface for a given channel. The Name property can be used to determine the name of a particular channel

Class-compliant IIviPwrMeter property that is used to reference a Channel interface for a given channel. The Name property can be used to determine the name of a particular channel

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. A pointer to a class-compliant IIviPwrMeterChannel interface.

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 IIviPwrMeterChannel interface.

Class-compliant IIviPwrMeter property that returns the name of a particular channel

Class-compliant IIviPwrMeter property that returns the name of a particular channel

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.

Class-compliant IIviPwrMeter property specifying the unit to which the RF power is converted after measurement

Class-compliant IIviPwrMeter interface containing methods and properties that applyto a particular channel

Class-compliant IIviPwrMeter method that performs a calibration on a particular channel and sensor. This method returns only after calibration is complete

Class-compliant IIviPwrMeter method that performs a zero operation on a particular channel

Reference to the class-compliant IIviPwrMeterAveraging interface

Class-compliant IIviPwrMeter property specifying the frequency of the input signal in Hertz. The instrument uses this value to determine the appropriate correction factor for the sensor

Reference to the class-compliant IIviPwrMeterDutyCycleCorrection interface

Class-compliant IIviPwrMeter property specifying whether the power meter should take a measurement on a particular input channel. The power meter will take a measurement on a channel only if that channel is enabled

Class-compliant IIviPwrMeter property specifying an offset to be added to the measured value in units of dB. This property can be used to compensate for system losses or gains between the unit under test and the power sensor

Reference to the class-compliant IIviPwrMeterRange interface

Class-compliant IIviPwrMeter interface containing methods and properties concerning averaging

Class-compliant IIviPwrMeter property specifying whether auto-averaging is enabled or disabled for a particular input channel

Class-compliant IIviPwrMeter property specifying the averaging count. When the Auto Averaging Enabled attribute is set to False, the driver filters the input signal by averaging it the number of times specified by this property

Class-compliant IIviPwrMeter interface containing methods and properties concerning duty cycle correction

Class-compliant IIviPwrMeter method that enables or disables duty cycle correction and sets the duty cycle for pulse power measurements

Enables or disables the duty cycle correction. This parameter sets the Duty Cycle Correction Enabled property. Specifies the expected value of the duty cycle correction. This parameter sets the Duty Cycle Correction property.

Class-compliant IIviPwrMeter property specifying whether duty cycle correction is enabled on a particular channel

Class-compliant IIviPwrMeter property specifying the duty cycle correction the power meter uses to calculate the pulse power of a pulse-modulated signal. The value of this attribute is specified as a percentage

Class-compliant IIviPwrMeter interface containing methods and properties concerning the meter and sensor range selection.

Class-compliant IIviPwrMeter method that configures the lower and upper range values for a particular channel

The lower limit of the expected value of the measurement. This parameter is sets the Range.Lower property. The upper limit of the expected value of the measurement. This parameter sets the Range.Upper property.

Class-compliant IIviPwrMeter property specifying if the power meter should set the best range for the measurement. If True, the instrument automatically sets the best range. If False, set the range using the Range.Upper and Range.Lower properties

Class-compliant IIviPwrMeter property specifying the lower limit (minimum) of the expected value of the measurement. The value of this property is specified in the same units as the value of the Channels.Units property

Class-compliant IIviPwrMeter property specifying the upper limit (maximum) of the expected value of the measurement. The value of this property is specified in the same units as the value of the Channels.Units property

Class-compliant IIviPwrMeter interface containing methods and properties for initiating and retreiving measurements

Class-compliant IIviPwrMeter method that aborts all previously initiated measurements and returns the power meter to the Idle state.

Class-compliant IIviPwrMeter method that configures the instrument to take single or dual channel measurements

The math function applied to the operands. The name of the channel from which the value for the first operand of the math function is measured. The name of the channel from which the value for the second operand of the math function is measured.

Class-compliant IIviPwrMeter method that returns the result of a previously configured and initiated 1 or 2 channel measurement. Measurement.Configure can be used to set up the measurement. Measurement.Initiate initiates that measurement

Measured value

Class-compliant IIviPwrMeter method that returns the result from a previously initiated measurement on a specified channel. Initiate initiates that measurement. The meaurement result will be returned in the units specified by the Unit property

The name of the channel from which to fetch the measurement. Measured value

Class-compliant IIviPwrMeter method that initiates a measurement on all enabled channels. When this method executes, the power meter leaves the Idle state

Class-compliant IIviPwrMeter method that queries the instrument to determine the status of the measurement initiated by the Initiate method. This method returns a status of Measurement only when measurements are complete on all enabled channels.

Returns the status of the measurement.

Class-compliant IIviPwrMeter method that takes a measurement value returned from Fetch, Fetch Channel, Read, or Read Channel and determines if the value is a valid measurement value or a value indicating that an out-of-range condition occurred.

The measurement value returned by one of the Fetch or Read functions. Returns whether the MeasurementValue is a valid measurement or a value indicating that the power meter encountered an out-of-range condition.

Class-compliant IIviPwrMeter method that initiates a previously configured measurement, waits until the power meter has returned to the Idle state, then returns the result of that measurement. Measurement.Configure can be used to set up the measurement

Specifies the maximum time in milliseconds to wait for a return value. It may also be one of the values in IviPwrMeterTimeOutEnum. Measured value.

Class-compliant IIviPwrMeter method that initiates a measurement, waits until the power meter has returned to the Idle state, then returns the result of the measurement on the specified channel

The name of the channel from which to take the measurement. Specifies the maximum time in seconds to wait for a return value. It may also be one of the values in IviPwrMeterTimeOutEnum. Measured value.

Class-compliant IIviPwrMeter method that sends a software trigger to the instrument

Class-compliant IIviPwrMeter interface containing methods and properties concerning the Reference Oscillator

Class-compliant IIviPwrMeter method that sets the frequency and power level of the signal generated by the reference oscillator

The frequency of the reference oscillator. This parameter sets the Reference Oscillator Frequency property. The power level of the reference oscillator. This parameter sets the Reference Oscillator Level property

Class-compliant IIviPwrMeter property specifying if the internal reference oscillator is enabled

Class-compliant IIviPwrMeter property specifying the frequency of the signal generated by the reference oscillator in Hertz

Class-compliant IIviPwrMeter property specifying the power level of the signal generated by the reference oscillator in dBm

Class-compliant IIviPwrMeter interface containing methods and properties concerning the triggering capabilities of the instrument

Class-compliant IIviPwrMeter property specifying the trigger source that the power meter monitors for a trigger event

Reference to the class-compliant IIviPwrMeterInternalTrigger interface

Class-compliant IIviPwrMeter interface containing methods and properties concerning the internal triggering capabilties of the instrument

Class-compliant IIviPwrMeter method that configures the internal trigger event source, slope and level

The name of the channel to use as the internal trigger event source. The driver uses this value to set the Internal Trigger Event Source attribute. See the attribute description for more information. The internal trigger slope. This value sets the Internal Trigger Slope property.

Class-compliant IIviPwrMeter property specifying the channel that the power meter uses to monitor the internal trigger event

Class-compliant IIviPwrMeter property specifying the trigger level for the measurement signal. The value of this property is specified in the same unit as the value of the Channels.Units property

Class-compliant IIviPwrMeter property specifying whether the power meter should trigger on the rising or falling edge of the measurement signal

IVI PwrMeter class-compliant values for Calibration Status

The power meter has completed the calibration.

The power meter is still performing calibration.

The power meter cannot determine the status of the calibration.

IVI PwrMeter class-compliant values for Zero Status

The power meter has completed all zero correction operations.

The power meter is still performing zero correction on one or more channels.

The power meter cannot determine the status of zero correction operations.

IVI PwrMeter class-compliant values for Units

Sets the units to dBm.

Sets the units to dB millivolts.

Sets the units to dB microvolts.

Sets the units to Watts.

IVI PwrMeter class-compliant values for Measurement Operator

Operand1

Operand1 - Operand2

Operand1 + Operand2

Operand1 / Operand2

IVI PwrMeter class-compliant values for Measurement Status

The power meter has completed the measurement on all enabled channels.

The power meter is still taking a measurement on one or more enabled channels.

The power meter cannot determine the status of the measurement.

IVI PwrMeter class-compliant values for Result Range

The measurement is within the current range limits.

The measurement is below the current lower range limit.

The measurement is above the current upper range limit.

IVI PwrMeter class-compliant values for Trigger Source

The power meter exits the Wait-For-Trigger state immediately after entering. It does not wait for a trigger of any kind.

The power meter exits the Wait-For-Trigger state when a trigger occurs on the external trigger input.

The power meter exits the Wait-For-Trigger state when an internal trigger event occurs on the measurement signal.

The power meter exits the Wait-For-Trigger state when it receives a software trigger.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The power meter exits the Wait-For-Trigger state when it receives a trigger on the RTS5 line.

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

IVI PwrMeter class-compliant values for Internal Trigger Slope

Sets the trigger event to occur on the falling edge of the trigger pulse.

Sets the trigger event to occur on the rising edge of the trigger pulse.

IVI PwrMeter class-compliant Errors

Measurement is under range.

Measurement is over range.

The specified channel is not enabled for measurement.

Maximum timeout exceeded before operation could complete.

The trigger source is not set to software trigger.

IVI PwrMeter class-compliant values for Time Out

The function waits indefinitely for the measurement to complete.

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