RFmxSpecAn_IDPDCfgPredistortedWaveform
- Updated2025-04-08
- 1 minute(s) read
Configures the predistorted waveform for the IDPD measurement.
Syntax
int32 __stdcall RFmxSpecAn_IDPDCfgPredistortedWaveform(niRFmxInstrHandle instrumentHandle, char selectorString[], float64 x0, float64 dx, NIComplexSingle predistortedWaveform[], int32 arraySize, float64 targetGain)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| instrumentHandle | [in] | niRFmxInstrHandle | This parameter specifies the RFmx session refnum. Instrument Handle In is obtained from the RFmxInstr_Initialize function. |
| selectorString | [in] | char | This parameter specifies a Selector String comprising of the signal name. If you do not specify the signal name, the default signal instance is used. The default value is "" (empty string). |
| x0 | [in] | float64 | This parameter specifies the start time, in seconds. |
| dx | [in] | float64 | This parameter specifies the sample duration, in seconds. |
| predistortedWaveform | [in] | NIComplexSingle | This parameter specifies the predistorted waveform for the measurement. |
| arraySize | [in] | int32 | Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter. |
| targetGain | [in] | float64 | This parameter specifies the target gain when the configured pre-distorted waveform is non-empty. This value is expressed in dB. |
Returns
Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.
To obtain a text description of the status code and additional information about the error condition, call the RFmxSpecAn_GetError function.
The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |