Timing.ConfigureSampleClock Method (String, Double, SampleClockActiveEdge, SampleQuantityMode, Int32)
- Updated2023-02-21
- 2 minute(s) read
TimingConfigureSampleClock Method (String, Double, SampleClockActiveEdge, SampleQuantityMode, Int32)
Sets the source of the sample clock, the rate of the sample clock, and the number of samples to acquire or generate.
Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302
Syntax
public void ConfigureSampleClock( string signalSource, double rate, SampleClockActiveEdge activeEdge, SampleQuantityMode sampleMode, int samplesPerChannel )
Public Sub ConfigureSampleClock ( 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 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.
 Note |
|---|
| Before calling this method, you must configure channels on the task using one of the channel collection properties (for example, CreateVoltageChannel(String, String, AITerminalConfiguration, Double, Double, String) on AIChannels). |