IviDownconverter_ConfigureFrequencyStepDwell
- Updated2023-02-24
- 1 minute(s) read
ViStatus IviDownconverter_ConfigureFrequencyStepDwell (ViSession instrumentHandle, ViBoolean singleStepEnabled, ViReal64 frequencyStepDwell_s);
Purpose
This function configures the attributes that control frequency stepping dwell.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| instrumentHandle | ViSession | The ViSession handle that you obtain from the IviDownconverter_init or IviDownconverter_InitWithOptions function. The handle identifies a particular instrument session.
Default Value: None |
| singleStepEnabled | ViBoolean | Enables or disables single step mode. The driver uses this value to set the IVIDOWNCONVERTER_ATTR_FREQUENCY_STEP_SINGLE_STEP_ENABLED attribute.
Valid Values: VI_TRUE - Enables single step mode. The frequency sweep advances when the next trigger event occurs. VI_FALSE - Disables single step mode. The frequency sweep advances immediately after the dwell time ends. Default Value: VI_FALSE |
| frequencyStepDwell_s | ViReal64 | Specifies the duration of one frequency step. The driver uses this value to set the IVIDOWNCONVERTER_ATTR_FREQUENCY_STEP_DWELL attribute.
Units: Seconds Default Value: 1.0 s Note: The dwell time starts immediately at the start of each step. No settling time is added. This value is valid only when IVIDOWNCONVERTER_ATTR_FREQUENCY_STEP_SINGLE_STEP_ENABLED is VI_FALSE. |