IviRFSigGen_ConfigureFrequencyStepStartStop
IviRFSigGenFrequencyStep Capability Group
C Function Prototype
ViStatus IviRFSigGen_ConfigureFrequencyStepStartStop (ViSession vi, ViReal64 start, ViReal64 stop, ViInt32 scaling, ViReal64 stepSize);
Purpose
This function configures the settings that control the step frequencies of the generator's RF output signal. These settings are start and stop frequency, step size, and lin/log scaling. If the stop frequency is less than the start frequency, the frequency decreases during the sweep.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviRFSigGen_init or IviRFSigGen_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| start | ViReal64 | Specifies the start frequency of the stepped sweep. If the stop frequency is less than the start frequency, the frequency decreases during the sweep. The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_START attribute. Units: Hertz Default Value: 500.0 KHz |
| stop | ViReal64 | Specifies the stop frequency of the stepped sweep. If the stop frequency is less than the start frequency, the frequency decreases during the sweep. The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_STOP attribute. Units: Hertz Default Value: 5.0 MHz |
| scaling | ViInt32 | Specifies the spacing of the steps. The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SCALING attribute. Defined Values: IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEAR - Linear scaling IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC - Logarithmic scaling Default Value: IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEAR |
| stepSize | ViReal64 | Specifies the step size. The driver uses this value to set the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SIZE attribute. Units: The units are Hz when the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SCALING attribute is set to IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LINEAR The value is unitless (factor) when the IVIRFSIGGEN_ATTR_FREQUENCY_STEP_SCALING attribute is set to IVIRFSIGGEN_VAL_FREQUENCY_STEP_SCALING_LOGARITHMIC. Default Value: 100 KHz |