ScopeAcquisition Class
- Updated2023-09-06
- 5 minute(s) read
ScopeAcquisition Class
Gets and sets the record to fetch from a channel that you specify.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeAcquisition
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeAcquisition
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public sealed class ScopeAcquisition : ScopeSubObject, IIviScopeAcquisition
Public NotInheritable Class ScopeAcquisition Inherits ScopeSubObject Implements IIviScopeAcquisition
The ScopeAcquisition type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Backlog |
Gets the number of (PointsDone) samples that have been acquired but not fetched for the record specified by RecordNumberToFetch.
|
| BinarySampleWidth |
Gets or sets the bit width of the binary data in the acquired waveform, which is useful for determining which binary fetch method to use.
|
| DataTransferBandwidthMax |
Gets or sets the maximum bandwidth that the device is allowed to consume.
|
| DataTransferBlockSize |
Gets or sets the maximum number of samples to transfer at one time from the device to host memory.
|
| DataTransferPacketSizePreferred |
Gets or sets the preferred size of the data field in the PCI Express (PCIe) packet during data transfer.
|
| DdcDataProcessingMode |
Gets or sets the way in which data is processed by the digital downconverter (DDC).
|
| EnabledChannels |
Returns a comma-separated list of the channels enabled for the session in ascending order.
|
| NumberOfMeasurementSamplesToFetch |
Specifies the number of samples to fetch when performing a measurement. Use -1 to fetch the actual record length.
|
| NumberOfPointsMin |
Gets or sets the minimum number of points you require in the waveform record for each channel. NI-SCOPE uses the value you specify to configure the record length that the digitizer uses for waveform acquisition. RecordLength returns the actual record length.
|
| NumberOfRecordsToFetch |
Gets or sets the number of records to fetch.
|
| OverflowErrorReportingMode |
Gets or sets the reporting mode when the onboard signal processing block detects an overflow in any of its stages. Overflows lead to clipping of the waveform.
|
| RecordLength |
Gets the actual number of points the digitizer acquires for each channel.
|
| RecordNumberToFetch |
Gets or sets the record to fetch from a channel you specify.
|
| Resolution |
Gets the bit width of valid data (as opposed to padding bits) in the acquired waveform.
|
| SampleMode |
Gets the ScopeSampleMode the digitizer is currently using.
|
| SampleRate |
Gets the effective sample rate using the current configuration in samples per second.
|
| SampleRateMin |
Gets or sets the sampling rate for the acquisition in samples per second.
|
| StartTime |
Specifies the length of time, in seconds, from the trigger event to the first point in the waveform record.
|
| TimePerRecord |
Gets or sets the length of time that corresponds to the record length.
|
| Type |
Specifies how the digitizer acquires data and fills the waveform record.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
For more information, refer to the Acquisition Functions topic in the NI High-Speed Digitizers Help or to the Fetch and Read topics in the NI-SCOPE Function Reference Help.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.