ScopeMeasurement Class
- Updated2023-09-06
- 4 minute(s) read
ScopeMeasurement Class
Represents the NIScope sub-objects that contain the properties and methods related to acquisition.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeMeasurement
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeMeasurement
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public sealed class ScopeMeasurement : ScopeSubObject, IIviScopeMeasurement
Public NotInheritable Class ScopeMeasurement Inherits ScopeSubObject Implements IIviScopeMeasurement
The ScopeMeasurement type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| FetchInterleavedData |
Gets or sets a value specifying whether to retrieve one array with alternating values on the NI 5620/5621.
| |
| FetchInterleavedIQData |
Specifies whether a fetch call retrieves a single waveform with I and Q interleaved, or two separate waveforms.
| |
| FetchOffset |
Specifies the offset, in samples, to start fetching data within each record. The offset is applied relative to FetchRelativeTo. The offset can be positive or negative.
| |
| FetchRelativeTo |
Gets or sets the position to start fetching within one record.
| |
| PointsDone |
Gets the actual number of samples acquired since the last fetch,
relative to the configured value for
FetchRelativeTo, including FetchOffset and for the current configured RecordNumberToFetch.
| |
| RecordsDone |
Gets the number of records that have been completely acquired.
| |
| RisInAutoSetupAllowed |
Specifies whether the digitizer should use RIS sample rates when searching for a frequency in autosetup.
|
Methods
| Name | Description | |
|---|---|---|
| Abort |
Aborts an acquisition and returns the digitizer to the Idle state. Call this method if the
digitizer times out waiting for a trigger.
| |
| AutoSetup |
Automatically configures the instrument. When this method is called, the digitizer senses the input signal and automatically configures many of the instrument settings.
If a signal is detected on a channel, the driver chooses the smallest available vertical range that is larger than the signal range.
| |
| Commit |
Commits to hardware all the parameter settings associated with the task.
| |
| 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.) | |
| Initiate |
Initiates a waveform acquisition.
| |
| Status |
Gets the status information about the acquisition.
| |
| 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.