ni-rfsg-dotnet-api-ref_doc

Content Type
Programming Language
Current manual
Table of Contents
Product Documentationni-rfsg-dotnet-api-ref_docRfsgArb.SetArbWaveformNextWritePosition MethodCurrent page
Table of Contents

RfsgArb.SetArbWaveformNextWritePosition Method

RfsgArb.SetArbWaveformNextWritePosition Method

RfsgArbSetArbWaveformNextWritePosition Method

Configures the start position to use the write a waveform with the next call to the WriteWaveform methods.

Namespace:  NationalInstruments.ModularInstruments.NIRfsg
Assembly:  NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022

Syntax

public void SetArbWaveformNextWritePosition(
	string name,
	RfsgArbWaveformRelativeWritePosition relativeTo,
	int offset
)
Public Sub SetArbWaveformNextWritePosition ( 
	name As String,
	relativeTo As RfsgArbWaveformRelativeWritePosition,
	offset As Integer
)

Parameters

name
Type: SystemString
The identity of the waveform. This string is case-insensitive, alphanumeric, and does not use reserved words.
relativeTo
Type: NationalInstruments.ModularInstruments.NIRfsgRfsgArbWaveformRelativeWritePosition
The reference position in the waveform. The position and offset together determine where to start loading data into the waveform.

Defined values:

  • StartOfWaveform - The reference position is relative to the start of the waveform.
  • CurrentPosition - The reference position is relative to the current position.
offset
Type: SystemInt32
The offset for relativeTo at which to start loading the data into the waveform.

Exceptions

ExceptionCondition
ObjectDisposedException The SetArbWaveformNextWritePosition(String, RfsgArbWaveformRelativeWritePosition, Int32) method was accessed after the associated NIRfsg object was disposed.

Remarks

This method allows you to write to arbitrary locations within the waveform.

These settings apply only to the next write to the waveform specified by the name of AllocateWaveform(String, Int32) or one of the WriteWaveform methods. Subsequent writes to that waveform begin where the last write ended, unless this method is called again.

If you use this method to write to the waveform that is currently generating, an undefined output may result.

Supported Devices: PXIe-5644/5645/5646, PXIe-5820/5830/5831/5832/5840

See Also

Was this information helpful?