Fetches I/Q data from multiple records in an acquisition in a memory optimized manner.

Syntax

Namespace: NationalInstruments.ModularInstruments.NIRfsa

public ComplexWaveformCollection< ComplexDouble > MemoryOptimizedFetchIQMultiRecordComplexWaveforms(long startingRecord, long numberOfRecords, long numberOfSamples, PrecisionTimeSpan timeout, ref ComplexWaveformCollection< ComplexDouble > waveforms, out RfsaWaveformInfo[] waveformInfo)

Remarks

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

Memory optimization is not guaranteed.

Parameters

NameTypeDescription
startingRecordlong

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

numberOfRecordslong

Specifies the number of records to fetch.

numberOfSampleslong

Specifies the number of samples per record.

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.

waveformsref ComplexWaveformCollection< ComplexDouble >

Contains the ComplexWaveformCollection object to be populated. New memory won't be allocated if the ComplexWaveformCollection object is not null and its number of records and number of samples are same as the numberOfRecords and the numberOfSamples respectively.

waveformInfoout RfsaWaveformInfo[]

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

Returns

The acquired waveform for each record fetched.

Exceptions

TypeDescription
System.ObjectDisposedException

The MemoryOptimizedFetchIQMultiRecordComplexWaveforms<T> method was accessed after the associated NIRfsa object was disposed.