NI-DAQmx .NET Framework 4.0 API Reference

Timing.ConfigurePipelinedSampleClock Method

Download PDF

Updated2023-02-21
2 minute(s) read

Sets the source of the sample clock, the rate of the sample clock, the number of samples to acquire or generate, and configures the sample clock for pipelining.

Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302

Syntax

public void ConfigurePipelinedSampleClock(
	string signalSource,
	double rate,
	SampleClockActiveEdge activeEdge,
	SampleQuantityMode sampleMode,
	int samplesPerChannel
)

Public Sub ConfigurePipelinedSampleClock ( 
	signalSource As String,
	rate As Double,
	activeEdge As SampleClockActiveEdge,
	sampleMode As SampleQuantityMode,
	samplesPerChannel As Integer
)

Parameters

signalSource: Type: SystemString
The source terminal of the clock. To use the internal clock of the device, set this value to Empty.
rate: Type: SystemDouble
The sampling rate in samples per second. If you use an external source for the sample clock, set this input to the maximum expected rate of that clock.
activeEdge: Type: NationalInstruments.DAQmxSampleClockActiveEdge
The edges of sample clock pulses on which to acquire or generate samples.
sampleMode: Type: NationalInstruments.DAQmxSampleQuantityMode
The duration of the task. A task is either finite and stops once the specified number of samples have been acquired or generated, or it is continuous and continues to acquire or generate samples until the task is explicitly stopped.
samplesPerChannel: Type: SystemInt32
The number of samples to acquire or generate if sampleMode is FiniteSamples. If sample mode is ContinuousSamples, NI-DAQmx uses this value to determine the buffer size.

Exceptions

Exception	Condition
DaqException	The NI-DAQmx driver returned an error.

Remarks

The device acquires or generates samples on each sample clock edge, but does not respond to certain triggers until a few sample clock edges later. Pipelining allows higher data transfer rates at the cost of increased trigger response latency. Refer to the device documentation for information about which triggers pipelining affects. This timing type allows handshaking using the Pause trigger, the Ready for Transfer event, or the Data Active event. Refer to the device documentation for more information.

This timing type is supported only by the NI 6536 and NI 6537.

The NI-DAQmx driver does not determine if the requested settings are possible until the task is verified. This method does not throw an exception for parameter values that are not compatible with your hardware or other settings in your task. To determine if all of the settings for a Task are valid, you must verify the task by starting the task, either with Start or by reading from or writing to the task, or by calling Control(TaskAction) with Verify.

You cannot apply this method to a subset of devices in the task, and you must apply this method to the task as a whole. You must call this method on the instance of Timing returned from the Timing property on the Task class. Accessing this method on instances of Timing returned from the ItemString property throws an exception.

NI-DAQmx .NET Framework 4.0 API Reference

Table of Contents

Timing.ConfigurePipelinedSampleClock Method

Syntax

Parameters

Exceptions

Remarks

See Also

Reference

Log in to get a better experience