Fetches I/Q data from a single record in a single acquisition to optimize memory.

Syntax

Namespace: NationalInstruments.ModularInstruments.NIRfsa

public ComplexWaveform< ComplexSingle > MemoryOptimizedFetchIQSingleRecordComplexWaveform(long recordNumber, long numberOfSamples, PrecisionTimeSpan timeout, ref ComplexWaveform< ComplexSingle > waveform, out RfsaWaveformInfo waveformInfo)

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, or ReadIQSingleRecordComplexWaveform, MemoryOptimizedReadIQSingleRecordComplex, or MemoryOptimizedReadIQSingleRecordComplexWaveform methods, as the fetch is performed as part of these methods.
Note

Memory optimization is not guaranteed.

Parameters

NameTypeDescription
recordNumberlong

Specifies the record to retrieve. Record numbers are zero-based.

numberOfSampleslong

Specifies the number of samples to fetch.

timeoutPrecisionTimeSpan

Specifies the time, in seconds, allotted for the method to complete before returning a timeout error. A value of NationalInstruments.PrecisionTimeSpan.MaxValue specifies the method waits until all data is available. A value of 0 specifies the method immediately returns available data.

waveformref ComplexWaveform< ComplexSingle >

Contains the ComplexWavefrom object to be populated. New memory won't be allocated if the ComplexWaveform object is not null and its sammpleCount is same as the numberOfSamples.

waveformInfoout RfsaWaveformInfo

Contains the absolute and relative timestamps for the operation, the time interval, and the actual number of samples read.

Returns

Returns the acquired waveform.

Exceptions

TypeDescription
System.ObjectDisposedException

The MemoryOptimizedFetchIQSingleRecordComplexWaveform property was accessed after the associated NIRfsa object was disposed.