IviSpecAn_ConfigureTraceType
IviSpecAnBase Capability Group
C Function Prototype
ViStatus IviSpecAn_ConfigureTraceType (ViSession vi, ViConstString traceName, ViInt32 traceType);
Purpose
This function configures the type of trace to acquire.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviSpecAn_init or IviSpecAn_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| traceName | ViConstString | Pass the name of the trace you are configuring.
This control accepts either a virtual repeated capability name or an instrument-specific trace name. Virtual repeated capability names are aliases for instrument-specific trace strings. The instrument-specific trace strings can differ from one instrument to another. Virtual repeated capability names allow you to use and swap instruments without having to change the trace names in your source code. You specify virtual repeated capability names in MAX. Default Value: "" Note: You can specify the trace name as a string variable or as a literal enclosed in double quotes. |
| traceType | ViInt32 | The type of trace to acquire. The driver sets the IVISPECAN_ATTR_TRACE_TYPE attribute to this value. Valid Values: IVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITE - 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. IVISPECAN_VAL_TRACE_TYPE_MAX_HOLD - Sets the spectrum analyzer to keep the data from either the previous data or the new sweep data, which ever is higher. IVISPECAN_VAL_TRACE_TYPE_MIN_HOLD - Sets the spectrum analyzer to keep the data from either the previous data or the new sweep data, which ever is lower. IVISPECAN_VAL_TRACE_TYPE_VIDEO_AVERAGE - Sets the spectrum analyzer to maintain a running average of the swept data. IVISPECAN_VAL_TRACE_TYPE_VIEW - Disables acquisition into this trace but displays the existing trace data. IVISPECAN_VAL_TRACE_TYPE_STORE - Disables acquisition and disables the display of the existing trace data. Default Value: IVISPECAN_VAL_TRACE_TYPE_CLEAR_WRITE |