RfsaIQAcquisition.MemoryOptimizedFetchIQSingleRecordComplexWaveform<T>(Int64, Int64, PrecisionTimeSpan, ComplexWaveform<T>) Method
- Updated2025-07-17
- 2 minute(s) read
Rfsa
Fetches I/Q data from a single record in an acquisition in a memory optimized manner.
Namespace: NationalInstruments.ModularInstruments.NIRfsa
Assembly: NationalInstruments.ModularInstruments.NIRfsa.Fx45 (in NationalInstruments.ModularInstruments.NIRfsa.Fx45.dll) Version: 2025
Syntax
public ComplexWaveform<T> MemoryOptimizedFetchIQSingleRecordComplexWaveform<T>( long recordNumber, long numberOfSamples, PrecisionTimeSpan timeout, ref ComplexWaveform<T> waveform )
Public Function MemoryOptimizedFetchIQSingleRecordComplexWaveform(Of T) ( recordNumber As Long, numberOfSamples As Long, timeout As PrecisionTimeSpan, ByRef waveform As ComplexWaveform(Of T) ) As ComplexWaveform(Of T)
Parameters
- recordNumber Int64
- Specifies the record to retrieve. Record numbers are zero-based.
- numberOfSamples Int64
- Specifies the number of samples to fetch.
- timeout PrecisionTimeSpan
- Specifies the time, in seconds, allotted for the method to complete before returning a timeout error. A value of MaxValue specifies that the method waits until all data is available. A value of 0 specifies that the method immediately returns available data.
- waveform ComplexWaveformT
- Contains the ComplexWaveform object to be populated. New memory won't be allocated if the ComplexWaveform object is not null and its sampleCount is same as the numberOfSamples.
Type Parameters
- T
- The type of the underlying data.
Supported Type: NationalInstruments.ComplexDouble and NationalInstruments.ComplexInt16
Return Value
ComplexWaveformTReturns the acquired waveform.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The MemoryOptimizedFetchIQSingleRecordComplexWaveformT(Int64, Int64, PrecisionTimeSpan, ComplexWaveformT) method was accessed after the associated NIRfsa object was disposed. |
Remarks
The fetch transfers acquired waveform
data from device memory to computer memory. The data was acquired to onboard memory previously by
the hardware after the acquisition was initiated. This method is not necessary if you use the
ReadIQSingleRecordComplex(PrecisionTimeSpan, RfsaWaveformInfo),
ReadIQSingleRecordComplexWaveform(PrecisionTimeSpan, RfsaWaveformInfo),
MemoryOptimizedReadIQSingleRecordComplex(PrecisionTimeSpan, ComplexDouble, RfsaWaveformInfo), or
MemoryOptimizedReadIQSingleRecordComplexWaveform(PrecisionTimeSpan, ComplexWaveformComplexDouble, RfsaWaveformInfo) methods,
as the fetch is performed as part of these methods.
Memory optimization is not guaranteed.