NA

Collapse All Expand All    

Functions

NameDescriptionAgNA_ChannelAsynchronousTriggerSweepThe method initiates all the sweeps on the channel.AgNA_ChannelClearAverageClears and restarts averaging of the measurement data.AgNA_ChannelGetCorrectionArraysGets the correction arrays for the channelAgNA_ChannelGetPortExtensionSets the extension value at the specified port.AgNA_ChannelMeasurementCreateCreates a new measurement with specified Source and Receiver port values.AgNA_ChannelMeasurementDataToMemorySaves measurement trace data in memory.AgNA_ChannelMeasurementDeleteDeletes the measurement from instrument.AgNA_ChannelMeasurementFetchComplexReturns real and imaginary values of measurement dataAgNA_ChannelMeasurementFetchFormattedReturns measurement data in the current format as set by the Measurement.Format property. Smith and Polar formats are not supported.AgNA_ChannelMeasurementFetchMemoryComplexReturns real and imaginary values of Memory dataAgNA_ChannelMeasurementFetchMemoryFormattedReturns measurement data in the current format as set by the Measurement.Format property. Smith and Polar formats are not supported.AgNA_ChannelMeasurementFetchXReturns the stimulus values for the specified channel.AgNA_ChannelMeasurementGetSParameterReturns the for Source port and Receiver port number specified in measurementAgNA_ChannelMeasurementLimitAddInserts or appends a new limit line in the limit table at the position specified by the Number property. If Number is greater than the number of limits currently defined, Number is set to the next available position in the limit table.AgNA_ChannelMeasurementLimitDeleteDeletes the limit line represented by number propertyAgNA_ChannelMeasurementLimitDeleteAllDeletes all the limit linesAgNA_ChannelMeasurementMarkerActivateActivates the selected marker.AgNA_ChannelMeasurementMarkerQueryBandwidthMethod QueryBandwidthAgNA_ChannelMeasurementMarkerQueryValueMethod QueryValueAgNA_ChannelMeasurementMarkerSearchMethod SearchAgNA_ChannelMeasurementMarkerSetValueFromMarkerMethod SetValueFromMarkerAgNA_ChannelMeasurementQueryStatisticsPerforms and returns the result of statistical operation specified by AgilentNAMeasurementStatisticEnumAgNA_ChannelMeasurementSetSParameterModifies the measurement parameter to specified value.AgNA_ChannelMeasurementTraceAutoScalePerforms autoscale on the selected traceAgNA_ChannelsAbortAborts all sweeps on all channels.AgNA_ChannelSegmentAddCenterSpanAdds a new segment using center and span frequency values.AgNA_ChannelSegmentAddStartStopAdds a new segment using start and stop frequency values.AgNA_ChannelSegmentDeleteDeletes the segment specified by number propertyAgNA_ChannelSegmentDeleteAllDeletes all the segmentsAgNA_ChannelSetCorrectionArraysWrites the correction data array to the Cal Set currently attached to the specified channel.AgNA_ChannelSetPortExtensionSets the extension value at the specified port.AgNA_ChannelSourcePowerGetAttenuationSets the attenuation level of the port.AgNA_ChannelSourcePowerGetAttenuationAutoSets the Auto Attenuation value of the specified portAgNA_ChannelSourcePowerGetCalibrationArrayGets the source power calibration array for the port.AgNA_ChannelSourcePowerGetCorrectionOnEnables and disables source power correction for the specified port on the specified channel.AgNA_ChannelSourcePowerGetLevelSets the power output level for specified portAgNA_ChannelSourcePowerSetAttenuationSets the attenuation level of the port.AgNA_ChannelSourcePowerSetAttenuationAutoSets the Auto Attenuation value of the specified portAgNA_ChannelSourcePowerSetCalibrationArraySets the source power calibration array for the port.AgNA_ChannelSourcePowerSetCorrectionOnEnables and disables source power correction for the specified port on the specified channel.AgNA_ChannelSourcePowerSetLevelSets the power output level for specified portAgNA_ChannelStimulusRangeConfigureCenterSpanSets the sweep range for the channel using center and span value of the frequenciesAgNA_ChannelStimulusRangeConfigureStartStopSets the sweep range for the channel using start and stop value of the frequenciesAgNA_ChannelTriggerSweepThis will trigger the sweeps on a channel. Method does not return until sweep complete or timeout value exceeded.AgNA_ClearErrorThis function clears the error code and error description for the current execution thread and for the IVI session. If the user specifies a valid IVI session for the Vi parameter, this function clears the error information for the session. If the user passes VI_NULL for the Vi parameter, this function clears the error information for the current execution thread. If the Vi parameter is an invalid session, the function does nothing and returns an error.AgNA_closeCloses the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called.AgNA_DisableQuickly places the instrument in a state where it has no, or minimal, effect on the external system to which it is connected. This state is not necessarily a known state.AgNA_error_messageTranslates the error return value from an IVI driver function to a user-readable string. The user should pass a buffer with at least 256 bytes for the ErrorMessage parameter.AgNA_error_queryQueries the instrument and returns instrument specific error information. This function can be used when QueryInstrumentStatus is True to retrieve error details when the driver detects an instrument error.AgNA_GetAttributeViBooleanThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_GetAttributeViInt32This routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_GetAttributeViReal64This routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_GetAttributeViSessionThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_GetAttributeViStringThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_GetChannelMeasurementMarkerNamethis function returns the physical identifier that corresponds to the one-based index that the user specifies. If the value that the user passes for the Index parameter is less than one or greater than the value of the corresponding Marker Count attribute, the function returns an empty string in the Name parameter and returns an error.AgNA_GetChannelMeasurementNamethis function returns the physical identifier that corresponds to the one-based index that the user specifies. If the value that the user passes for the Index parameter is less than one or greater than the value of the corresponding Measurement Count attribute, the function returns an empty string in the Name parameter and returns an error.AgNA_GetChannelNamethis function returns the physical identifier that corresponds to the one-based index that the user specifies. If the value that the user passes for the Index parameter is less than one or greater than the value of the corresponding Channel Count attribute, the function returns an empty string in the Name parameter and returns an error.AgNA_GetErrorThis function retrieves and then clears the IVI error information for the session or the current execution thread. If the user specifies a valid IVI session for the Vi parameter, Get Error retrieves and then clears the error information for the session. If the user passes VI_NULL for the Vi parameter, Get Error retrieves and then clears the error information for the current execution thread. If the Vi parameter is an invalid session, the function does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called the Get Error or Clear Error function.AgNA_GetNextCoercionRecordNot Supported -Returns the oldest record from the coercion record list. Records are only added to the list if RecordCoercions is True.AgNA_initOpens 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.AgNA_InitWithOptionsOpens 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.AgNA_InvalidateAllAttributesInvalidates all of the driver's cached values.AgNA_LockSessionObtains a multithread lock on the driver after waiting until all other execution threads have released their locks on the instrument session.AgNA_resetPlaces the instrument in a known state and configures instrument options on which the IVI specific driver depends (for example, enabling/disabling headers). For an IEEE 488.2 instrument, Reset sends the command string *RST to the instrument.AgNA_ResetWithDefaultsDoes the equivalent of Reset and then, (1) disables class extension capability groups, (2) sets attributes to initial values defined by class specs, and (3) configures the driver to option string settings used when Initialize was last executed.AgNA_revision_queryRetrieves revision information from the instrument.AgNA_self_testPerforms an instrument self test, waits for the instrument to complete the test, and queries the instrument for the results. If the instrument passes the test, TestResult is zero and TestMessage is 'Self test passed'.AgNA_SetAttributeViBooleanThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_SetAttributeViInt32This routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_SetAttributeViReal64This routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_SetAttributeViSessionThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_SetAttributeViStringThis routine is used to access low-level settings of the instrument. See the attributeID parameter for a link to all attributes of the instrument.AgNA_StatusClearClear event registers and error queue.AgNA_StatusConfigureServiceRequestConfigure instrument to issue an SRQ on events defined in the SRQReasonEnum parameter. Clears previous settings. SRQReasonEnum is a power of 2 and multiple enum values may be ORed together to set SRQs on multiple conditions.AgNA_StatusGetRegisterRead and write instrument status registers. All Event and Condition registers and the Status byte are read only.AgNA_StatusPresetDefaults bits in most of the enable and transition registers. It presets all the Transition Filters, Enable Registers, and the Error/Event Queue Enable. It has no effect on Event Registers, Error/Event QUEue, IEEE 488.2 ESE, and SRE registers.AgNA_StatusSetRegisterRead and write instrument status registers. All Event and Condition registers and the Status byte are read only.AgNA_SystemDisableLocalControlsInstrument front panel disable. GPIB only.AgNA_SystemEnableLocalControlsInstrument front panel enable. GPIB only.AgNA_SystemReadThis function provides direct read access to the underlying instrument I/O interface.AgNA_SystemReadStringReads a complete response from the instrument and returns it as a string.AgNA_SystemRecallStateRecalls the instrument state from the specified instrument memory register.AgNA_SystemSaveStateStores the current instrument state to the specified instrument memory register.AgNA_SystemWaitForOperationCompleteMethod returns when all pending operations are complete or MaxTimeMilliseconds exceeded.AgNA_SystemWriteThis function provides direct write access to the underlying instrument I/O interface.AgNA_SystemWriteStringWrite a string to the device.AgNA_UnlockSessionReleases a previously obtained multithread lock.AgNA_viReadReads a complete response from the instrument and returns it as an array of bytes.AgNA_viWriteWrite an array of bytes to the device.Top

Attributes

NameDescriptionAGNA_ATTR_CACHEDrivers may choose to always cache some instrument settings, never cache others, and optionally cache others, to avoid unnecessary I/O to the instrument. If True, the driver caches optionally cached instrument settings.AGNA_ATTR_CHANNEL_AVERAGINGTurns trace averaging ON or OFF.AGNA_ATTR_CHANNEL_AVERAGING_FACTORSets the number of measurement sweeps to combine for an average.AGNA_ATTR_CHANNEL_CORRECTIONSets the correction state for all measurements on the channel.AGNA_ATTR_CHANNEL_COUNTAttribute that contains the number of Channels available on the instrument. This is the maximum index that may be used with the GetChannelName() function.AGNA_ATTR_CHANNEL_CW_FREQUENCYSets the Continuous Wave frequency.AGNA_ATTR_CHANNEL_IF_BANDWIDTHSets the bandwidth of the digital IF filter to be used in the measurement.AGNA_ATTR_CHANNEL_MEASUREMENT_COUNTAttribute that contains the number of Measurements available on the instrument. This is the maximum index that may be used with the GetChannelMeasurementName() function.AGNA_ATTR_CHANNEL_MEASUREMENT_FORMATSets the display format specified by AgilentNAMeasurementFormatEnum for the measurementAGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_ENABLEEnables/Disables the limit checkingAGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_IS_PASSINGReturn the status of limit line failures.AGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_NUMBERSets the current limit numberAGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_BANDWIDTH_THRESHOLDTurns on and sets markers 1 through 4 to calculate filter bandwidth. The value sets the point below the maximum bandwidth peak that establishes the bandwidth of a filter.AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_COUNTAttribute that contains the number of Markers available on the instrument. This is the maximum index that may be used with the GetChannelMeasurementMarkerName() function.AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_ENABLEDTurns the specified marker ON or OFFAGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_MARKER_TRACK_ENABLEDSets the tracking capability for the specified marker. The tracking function finds the selected search function every sweep.AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_PEAK_EXCURSIONSets amplitude peak excursion for the specified marker. The Excursion value determines what is considered a 'peak'. This command applies to marker peak searches (Next peak, Peak Right, Peak Left).AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_STIMULUSSets the marker's X-axis value (frequency, power, or time).AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_TARGET_VALUESets the target value for the specified marker when doing Target Searches.AGNA_ATTR_CHANNEL_MEASUREMENT_SMOOTHINGEnables/Disables smoothing on measurementAGNA_ATTR_CHANNEL_MEASUREMENT_SMOOTHING_APERTURESets the value of smoothing aperture for the measurementAGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_MATHSets the mathematical operation to be performed on the traceAGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_REFERENCE_POSITIONSets the value of reference positionAGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_REFERENCE_VALUESets the reference value.AGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_Y_SCALESets the Y scale for the trace.AGNA_ATTR_CHANNEL_NUMBERGet the current channel numberAGNA_ATTR_CHANNEL_POINTSSets the number of data points for the measurement.AGNA_ATTR_CHANNEL_PORT_EXTENSION_STATUSTurns port extensions ON or OFF.AGNA_ATTR_CHANNEL_SEGMENT_NUMBERSets the segment numberAGNA_ATTR_CHANNEL_SOURCEPOWER_COUPLINGTurns Port Power Coupling ON or OFF.AGNA_ATTR_CHANNEL_STIMULUSRANGE_CENTERSets the center frequency value of the sweep for the channelAGNA_ATTR_CHANNEL_STIMULUSRANGE_SPANSets the span value of the sweep for the channelAGNA_ATTR_CHANNEL_STIMULUSRANGE_STARTSets the start value of the sweep range of channelAGNA_ATTR_CHANNEL_STIMULUSRANGE_STOPSets the stop value of the sweep range of channelAGNA_ATTR_CHANNEL_SWEEP_MODEGets the current sweep mode.AGNA_ATTR_CHANNEL_SWEEP_TIMESets the time, the analyzer takes to complete one sweep.AGNA_ATTR_CHANNEL_SWEEP_TIME_AUTOTurns the automatic sweep time function ON or OFF.AGNA_ATTR_CHANNEL_SWEEP_TYPESets the sweep type of channel.AGNA_ATTR_CHANNEL_TRIGGER_MODESets the trigger mode for the specified channel.AGNA_ATTR_DISPLAY_ENABLEDEnables or Disables the display update.AGNA_ATTR_DRIVER_SETUPThe driver setup string. It is either specified in the Configuration Store or passed in the OptionString parameter of the Initialize function. Driver setup is empty if the driver is not initialized.AGNA_ATTR_GROUP_CAPABILITIESA comma-separated list of the class capability groups implemented by the driver. Capability group names are documented in the IVI class specifications. If the driver is not class compliant, the driver returns an empty string.AGNA_ATTR_INSTRUMENT_FIRMWARE_REVISIONThe firmware revision reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the firmware revision, a string is returned that explains the condition.AGNA_ATTR_INSTRUMENT_MANUFACTURERThe name of the manufacturer reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the name of the manufacturer, a string is returned that explains the condition. Manufacturer is limited to 256 bytesAGNA_ATTR_INSTRUMENT_MODELThe model number or name reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the model number or name, a string is returned that explains the condition. Model is limited to 256 bytesAGNA_ATTR_INTERCHANGE_CHECKNot Supported -If True, the driver maintains a record of interchangeability warnings. If the driver does not support interchangeability checking, attempts to set InterchangeCheck to True return an error.AGNA_ATTR_IO_RESOURCE_DESCRIPTORThe resource descriptor specifies the connection to a physical device. It is either specified in the Configuration Store or passed in the ResourceName parameter of the Initialize function. It is empty if the driver is not initialized.AGNA_ATTR_LOGICAL_NAMELogical Name identifies a driver session in the Configuration Store. If Logical Name is not empty, the driver was initialized from information in the driver session. If it is empty, the driver was initialized without using the Configuration Store.AGNA_ATTR_QUERY_INSTRUMENT_STATUSIf True, the driver queries the instrument status at the end of each method or property that performs I/O to the instrument. If an error is reported, use ErrorQuery to retrieve error messages one at a time from the instrument.AGNA_ATTR_RANGE_CHECKDrivers may choose to always validate some property/parameter values, never validate others, and optionally validate others, to avoid sending invalid commands to the instrument. If True, the driver performs optional validations.AGNA_ATTR_RECORD_COERCIONSNot Supported -If True, the driver keeps a list of the value coercions it makes for ViInt32 and ViReal64 attributes. If the driver does not support coercion recording, attempts to set RecordCoercions to True will return an error.AGNA_ATTR_SIMULATEIf True, the driver does not perform I/O to the instrument, and returns simulated values for output parameters.AGNA_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSIONReturns the major version number of the class specification in accordance with which the IVI specific driver was developed. Zero is returned if the driver is not compliant with a class specification.AGNA_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSIONReturns the minor version number of the class specification in accordance with which the IVI specific driver was developed. Zero is returned if the driver is not compliant with a class specification.AGNA_ATTR_SPECIFIC_DRIVER_DESCRIPTIONReturns a brief description of the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.AGNA_ATTR_SPECIFIC_DRIVER_PREFIXReturns the case-sensitive prefix of the user-callable functions that the IVI-C specific driver exports. The string that this attribute returns contains a maximum of 32 bytes including the NUL byte.AGNA_ATTR_SPECIFIC_DRIVER_REVISIONReturns version information about the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.AGNA_ATTR_SPECIFIC_DRIVER_VENDORReturns the name of the vendor that supplies the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.AGNA_ATTR_STATUS_SERIAL_POLLSerial poll the instrument status byte.AGNA_ATTR_SUPPORTED_INSTRUMENT_MODELSA comma-separated list of instrument models that the IVI specific driver can control. The string does not include an abbreviation for the manufacturer if it is the same for all models.AGNA_ATTR_SYSTEM_IO_TIMEOUTThe I/O timeout in milliseconds. The client program should normally not need to set the timeout. Driver methods with operations which take a significant time to perform are responsible for adjusting the I/O timeout to an appropriate value.AGNA_ATTR_SYSTEM_SERIAL_NUMBERInstrument serial numberAGNA_ATTR_SYSTEM_TIME_OUT_MILLISECONDSI/O timeout value in millisecondsAGNA_ATTR_SYSTEM_TRACE_ENABLEDDriver tracing enabledAGNA_ATTR_TRIGGER_SOURCESelects the trigger source from the following types Internal, ExternalTop

Copyright Keysight Technologies 2006-2015.