ScopeChannelMeasurement.FetchArrayMeasurement Method (PrecisionTimeSpan, ScopeArrayMeasurementType, AnalogWaveformCollection(Double))
- Updated2023-09-06
- 2 minute(s) read
ScopeChannelMeasurementFetchArrayMeasurement Method (PrecisionTimeSpan, ScopeArrayMeasurementType, AnalogWaveformCollectionDouble)
Obtains a waveform from the digitizer and returns the specified measurement array. This method may return multiple waveforms depending on the number of channels, the acquisition type,
and the number of records you specify.
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public AnalogWaveformCollection<double> FetchArrayMeasurement( PrecisionTimeSpan timeout, ScopeArrayMeasurementType arrayMeasurementType, AnalogWaveformCollection<double> measurementWaveforms )
Public Function FetchArrayMeasurement ( timeout As PrecisionTimeSpan, arrayMeasurementType As ScopeArrayMeasurementType, measurementWaveforms As AnalogWaveformCollection(Of Double) ) As AnalogWaveformCollection(Of Double)
Parameters
- timeout
- Type: NationalInstrumentsPrecisionTimeSpan
The time to wait for data to be acquired. Using 0 for this parameter tells NI-SCOPE to fetch whatever is currently available. Using -1 for this parameter implies infinite timeout. - arrayMeasurementType
- Type: NationalInstruments.ModularInstruments.NIScopeScopeArrayMeasurementType
The type of the array measurement to perform. - measurementWaveforms
- Type: NationalInstrumentsAnalogWaveformCollectionDouble
The waveform object whose memory can be reused while creating the output waveform. To allocate memory during the call to this method, set measurementWaveforms to . The method will also allocate memory during the call if measurementWaveforms is set to a waveform object with zero-sized data or measurementWaveforms is set to a waveform object with a different size than that required for the output waveform. For example, if measurementWaveforms is set to a waveform object with the same size as that required for this method call, then no new memory is allocated for the output waveform, and instead the memory of the waveform object from measurementWaveforms will be reused for the output waveform.
Return Value
Type: AnalogWaveformCollectionDoubleAn array of type AnalogWaveformCollectionTData.
Exceptions
Exception | Condition |
---|---|
ObjectDisposedException | FetchArrayMeasurement(PrecisionTimeSpan, ScopeArrayMeasurementType, AnalogWaveformCollectionDouble) was called after the associated NIScope or ScopeDriverUtility object was disposed. |
IviCDriverException |
The value of arrayMeasurementType was invalid.
- or - The underlying NI-SCOPE driver returned an error. |
Remarks
Some functionality, such as time stamping, is not supported in all digitizers. Refer to Features Supported by Device for more information.