NA

Collapse All Expand All     Functions Name Description AgNA_ChannelAsynchronousTriggerSweep The method initiates all the sweeps on the channel. AgNA_ChannelClearAverage Clears and restarts averaging of the measurement data. AgNA_ChannelGetCorrectionArrays Gets the correction arrays for the channel AgNA_ChannelGetPortExtension Sets the extension value at the specified port. AgNA_ChannelMeasurementCreate Creates a new measurement with specified Source and Receiver port values. AgNA_ChannelMeasurementDataToMemory Saves measurement trace data in memory. AgNA_ChannelMeasurementDelete Deletes the measurement from instrument. AgNA_ChannelMeasurementFetchComplex Returns real and imaginary values of measurement data AgNA_ChannelMeasurementFetchFormatted Returns measurement data in the current format as set by the Measurement.Format property. Smith and Polar formats are not supported. AgNA_ChannelMeasurementFetchMemoryComplex Returns real and imaginary values of Memory data AgNA_ChannelMeasurementFetchMemoryFormatted Returns measurement data in the current format as set by the Measurement.Format property. Smith and Polar formats are not supported. AgNA_ChannelMeasurementFetchX Returns the stimulus values for the specified channel. AgNA_ChannelMeasurementGetSParameter Returns the for Source port and Receiver port number specified in measurement AgNA_ChannelMeasurementLimitAdd Inserts 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_ChannelMeasurementLimitDelete Deletes the limit line represented by number property AgNA_ChannelMeasurementLimitDeleteAll Deletes all the limit lines AgNA_ChannelMeasurementMarkerActivate Activates the selected marker. AgNA_ChannelMeasurementMarkerQueryBandwidth Method QueryBandwidth AgNA_ChannelMeasurementMarkerQueryValue Method QueryValue AgNA_ChannelMeasurementMarkerSearch Method Search AgNA_ChannelMeasurementMarkerSetValueFromMarker Method SetValueFromMarker AgNA_ChannelMeasurementQueryStatistics Performs and returns the result of statistical operation specified by AgilentNAMeasurementStatisticEnum AgNA_ChannelMeasurementSetSParameter Modifies the measurement parameter to specified value. AgNA_ChannelMeasurementTraceAutoScale Performs autoscale on the selected trace AgNA_ChannelsAbort Aborts all sweeps on all channels. AgNA_ChannelSegmentAddCenterSpan Adds a new segment using center and span frequency values. AgNA_ChannelSegmentAddStartStop Adds a new segment using start and stop frequency values. AgNA_ChannelSegmentDelete Deletes the segment specified by number property AgNA_ChannelSegmentDeleteAll Deletes all the segments AgNA_ChannelSetCorrectionArrays Writes the correction data array to the Cal Set currently attached to the specified channel. AgNA_ChannelSetPortExtension Sets the extension value at the specified port. AgNA_ChannelSourcePowerGetAttenuation Sets the attenuation level of the port. AgNA_ChannelSourcePowerGetAttenuationAuto Sets the Auto Attenuation value of the specified port AgNA_ChannelSourcePowerGetCalibrationArray Gets the source power calibration array for the port. AgNA_ChannelSourcePowerGetCorrectionOn Enables and disables source power correction for the specified port on the specified channel. AgNA_ChannelSourcePowerGetLevel Sets the power output level for specified port AgNA_ChannelSourcePowerSetAttenuation Sets the attenuation level of the port. AgNA_ChannelSourcePowerSetAttenuationAuto Sets the Auto Attenuation value of the specified port AgNA_ChannelSourcePowerSetCalibrationArray Sets the source power calibration array for the port. AgNA_ChannelSourcePowerSetCorrectionOn Enables and disables source power correction for the specified port on the specified channel. AgNA_ChannelSourcePowerSetLevel Sets the power output level for specified port AgNA_ChannelStimulusRangeConfigureCenterSpan Sets the sweep range for the channel using center and span value of the frequencies AgNA_ChannelStimulusRangeConfigureStartStop Sets the sweep range for the channel using start and stop value of the frequencies AgNA_ChannelTriggerSweep This will trigger the sweeps on a channel. Method does not return until sweep complete or timeout value exceeded. AgNA_ClearError This 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_close Closes the I/O session to the instrument. Driver methods and properties that access the instrument are not accessible after Close is called. AgNA_Disable Quickly 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_message Translates 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_query Queries 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_GetAttributeViBoolean This 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_GetAttributeViInt32 This 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_GetAttributeViReal64 This 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_GetAttributeViSession This 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_GetAttributeViString This 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_GetChannelMeasurementMarkerName this 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_GetChannelMeasurementName this 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_GetChannelName this 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_GetError This 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_GetNextCoercionRecord Not Supported -Returns the oldest record from the coercion record list. Records are only added to the list if RecordCoercions is True. AgNA_init 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. AgNA_InitWithOptions 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. AgNA_InvalidateAllAttributes Invalidates all of the driver's cached values. AgNA_LockSession Obtains a multithread lock on the driver after waiting until all other execution threads have released their locks on the instrument session. AgNA_reset Places 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_ResetWithDefaults Does 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_query Retrieves revision information from the instrument. AgNA_self_test Performs 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_SetAttributeViBoolean This 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_SetAttributeViInt32 This 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_SetAttributeViReal64 This 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_SetAttributeViSession This 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_SetAttributeViString This 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_StatusClear Clear event registers and error queue. AgNA_StatusConfigureServiceRequest Configure 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_StatusGetRegister Read and write instrument status registers. All Event and Condition registers and the Status byte are read only. AgNA_StatusPreset Defaults 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_StatusSetRegister Read and write instrument status registers. All Event and Condition registers and the Status byte are read only. AgNA_SystemDisableLocalControls Instrument front panel disable. GPIB only. AgNA_SystemEnableLocalControls Instrument front panel enable. GPIB only. AgNA_SystemRead This function provides direct read access to the underlying instrument I/O interface. AgNA_SystemReadString Reads a complete response from the instrument and returns it as a string. AgNA_SystemRecallState Recalls the instrument state from the specified instrument memory register. AgNA_SystemSaveState Stores the current instrument state to the specified instrument memory register. AgNA_SystemWaitForOperationComplete Method returns when all pending operations are complete or MaxTimeMilliseconds exceeded. AgNA_SystemWrite This function provides direct write access to the underlying instrument I/O interface. AgNA_SystemWriteString Write a string to the device. AgNA_UnlockSession Releases a previously obtained multithread lock. AgNA_viRead Reads a complete response from the instrument and returns it as an array of bytes. AgNA_viWrite Write an array of bytes to the device. Top Attributes Name Description AGNA_ATTR_CACHE Drivers 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_AVERAGING Turns trace averaging ON or OFF. AGNA_ATTR_CHANNEL_AVERAGING_FACTOR Sets the number of measurement sweeps to combine for an average. AGNA_ATTR_CHANNEL_CORRECTION Sets the correction state for all measurements on the channel. AGNA_ATTR_CHANNEL_COUNT Attribute 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_FREQUENCY Sets the Continuous Wave frequency. AGNA_ATTR_CHANNEL_IF_BANDWIDTH Sets the bandwidth of the digital IF filter to be used in the measurement. AGNA_ATTR_CHANNEL_MEASUREMENT_COUNT Attribute 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_FORMAT Sets the display format specified by AgilentNAMeasurementFormatEnum for the measurement AGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_ENABLE Enables/Disables the limit checking AGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_IS_PASSING Return the status of limit line failures. AGNA_ATTR_CHANNEL_MEASUREMENT_LIMIT_NUMBER Sets the current limit number AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_BANDWIDTH_THRESHOLD Turns 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_COUNT Attribute 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_ENABLED Turns the specified marker ON or OFF AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_MARKER_TRACK_ENABLED Sets the tracking capability for the specified marker. The tracking function finds the selected search function every sweep. AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_PEAK_EXCURSION Sets 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_STIMULUS Sets the marker's X-axis value (frequency, power, or time). AGNA_ATTR_CHANNEL_MEASUREMENT_MARKER_TARGET_VALUE Sets the target value for the specified marker when doing Target Searches. AGNA_ATTR_CHANNEL_MEASUREMENT_SMOOTHING Enables/Disables smoothing on measurement AGNA_ATTR_CHANNEL_MEASUREMENT_SMOOTHING_APERTURE Sets the value of smoothing aperture for the measurement AGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_MATH Sets the mathematical operation to be performed on the trace AGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_REFERENCE_POSITION Sets the value of reference position AGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_REFERENCE_VALUE Sets the reference value. AGNA_ATTR_CHANNEL_MEASUREMENT_TRACE_Y_SCALE Sets the Y scale for the trace. AGNA_ATTR_CHANNEL_NUMBER Get the current channel number AGNA_ATTR_CHANNEL_POINTS Sets the number of data points for the measurement. AGNA_ATTR_CHANNEL_PORT_EXTENSION_STATUS Turns port extensions ON or OFF. AGNA_ATTR_CHANNEL_SEGMENT_NUMBER Sets the segment number AGNA_ATTR_CHANNEL_SOURCEPOWER_COUPLING Turns Port Power Coupling ON or OFF. AGNA_ATTR_CHANNEL_STIMULUSRANGE_CENTER Sets the center frequency value of the sweep for the channel AGNA_ATTR_CHANNEL_STIMULUSRANGE_SPAN Sets the span value of the sweep for the channel AGNA_ATTR_CHANNEL_STIMULUSRANGE_START Sets the start value of the sweep range of channel AGNA_ATTR_CHANNEL_STIMULUSRANGE_STOP Sets the stop value of the sweep range of channel AGNA_ATTR_CHANNEL_SWEEP_MODE Gets the current sweep mode. AGNA_ATTR_CHANNEL_SWEEP_TIME Sets the time, the analyzer takes to complete one sweep. AGNA_ATTR_CHANNEL_SWEEP_TIME_AUTO Turns the automatic sweep time function ON or OFF. AGNA_ATTR_CHANNEL_SWEEP_TYPE Sets the sweep type of channel. AGNA_ATTR_CHANNEL_TRIGGER_MODE Sets the trigger mode for the specified channel. AGNA_ATTR_DISPLAY_ENABLED Enables or Disables the display update. AGNA_ATTR_DRIVER_SETUP The 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_CAPABILITIES A 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_REVISION The 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_MANUFACTURER The 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 bytes AGNA_ATTR_INSTRUMENT_MODEL The 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 bytes AGNA_ATTR_INTERCHANGE_CHECK Not 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_DESCRIPTOR The 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_NAME Logical 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_STATUS If 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_CHECK Drivers 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_COERCIONS Not 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_SIMULATE If 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_VERSION Returns 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_VERSION Returns 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_DESCRIPTION Returns 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_PREFIX Returns 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_REVISION Returns 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_VENDOR Returns 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_POLL Serial poll the instrument status byte. AGNA_ATTR_SUPPORTED_INSTRUMENT_MODELS A 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_TIMEOUT The 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_NUMBER Instrument serial number AGNA_ATTR_SYSTEM_TIME_OUT_MILLISECONDS I/O timeout value in milliseconds AGNA_ATTR_SYSTEM_TRACE_ENABLED Driver tracing enabled AGNA_ATTR_TRIGGER_SOURCE Selects the trigger source from the following types Internal, External Top Copyright Keysight Technologies 2006-2015.