Timing Class

Download PDF

Updated2023-02-21
14 minute(s) read

Timing Class

Contains properties and methods that configure the sample timing and duration of the Task.

Inheritance Hierarchy

SystemObject
SystemMarshalByRefObject
NationalInstruments.DAQmxTiming

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

Syntax

public class Timing : MarshalByRefObject, IFilteredTypeDescriptor, 
	IServiceProvider

Public Class Timing
	Inherits MarshalByRefObject
	Implements IFilteredTypeDescriptor, IServiceProvider

The Timing type exposes the following members.

Properties

	Name	Description
	AIConvertActiveEdge	Specifies on which edge of the clock pulse an analog-to-digital conversion takes place.
	AIConvertMaximumRate	Indicates the maximum convert rate supported by the task, given the current devices and channel count.
	AIConvertRate	Specifies in Hertz the rate at which to clock the analog-to-digital converter. This clock is specific to the analog input section of multiplexed devices.
	AIConvertSource	Specifies the terminal of the signal to use as the AI Convert Clock.
	AIConvertTimebaseDivisor	Specifies the number of AI Convert Clock Timebase pulses needed to produce a single AI Convert Clock pulse.
	AIConvertTimebaseSource	Specifies the terminal of the signal to use as the AI Convert Clock Timebase.
	ChangeDetectionDIFallingEdgePhysicalChannels	Specifies the names of the digital lines or ports on which to detect falling edges. The lines or ports must be used by virtual channels in the task. You also can specify a string that contains a list or range of digital lines or ports.
	ChangeDetectionDIRisingEdgePhysicalChannels	Specifies the names of the digital lines or ports on which to detect rising edges. The lines or ports must be used by virtual channels in the task. You also can specify a string that contains a list or range of digital lines or ports.
	ChangeDetectionDITristate	Specifies whether to tristate lines specified with ChangeDetectionDIRisingEdgePhysicalChannels and ChangeDetectionDIFallingEdgePhysicalChannels that are not in a virtual channel in the task. If you set this property to , NI-DAQmx tristates rising/falling edge lines that are not in a virtual channel in the task. If you set this property to , NI-DAQmx does not modify the configuration of rising/falling edge lines that are not in a virtual channel in the task, even if the lines were previously tristated. Set this property to to detect changes on lines in other tasks or to detect changes on output-only lines.
	ChangeDetectionOverflowed	Indicates if samples were missed because change detection events occurred faster than the device could handle them. Some devices detect overflows differently than others.
	DelayFromSampleClock	Specifies the amount of time to wait after receiving a Sample Clock edge before beginning to acquire the sample. This value is in the units you specify with DelayFromSampleClockUnits.
	DelayFromSampleClockUnits	Specifies the units of DelayFromSampleClock.
	DigitalFilterEnable	Specifies whether to apply a digital filter to the AI Convert Clock.
	DigitalFilterMinimumPulseWidth	Specifies in seconds the minimum pulse width the filter recognizes.
	DigitalFilterTimebaseRate	Specifies in hertz the rate of the digital filter timebase. NI-DAQmx uses this value to compute settings for the filter.
	DigitalFilterTimebaseSource	Specifies the terminal of the signal to use as the timebase of the digital filter.
	DigitalSynchronizationEnable	Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.
	FirstSampleClockOffset	Specifies, in seconds, the offset to apply to the FirstSampleClockTime value. This offset modifies when the first sample clock occurs and is used to account for known delays in the signal path.
	FirstSampleClockTime	Gets or sets the time of the first sample clock.
	FirstSampleClockTimescale	Specifies the timescale to be used for the value of FirstSampleClockTime.
	FirstSampleTimestamp	Gets the timestamp of the first sample.
	FirstSampleTimestampEnable	Specifies whether to enable the first sample timestamp.
	FirstSampleTimestampTimescale	Specifies the timescale to be used for the first sample timestamp.
	HandshakeDelayAfterTransfer	Specifies the number of seconds to wait after a handshake cycle before starting a new handshake cycle.
	HandshakeSampleInputDataCondition	Specifies on which edge of the Handshake Trigger an input task latches the data from the peripheral device.
	HandshakeStartCondition	Specifies the point in the handshake cycle that the device is in when the task starts.
	ImplicitUnderflowBehavior	Specifies the action to take when the onboard memory of the device becomes empty.
	Item	Gets an instance of Timing that contains settings for only the specified devices. In Visual C#, this property is the indexer.
	MasterTimebaseRate	Specifies the rate of the Master Timebase.
	MasterTimebaseSource	Specifies the terminal of the signal to use as the Master Timebase. On an E Series device, you can choose only between the onboard 20MHz Timebase or the RTSI7 terminal.
	OnDemandAOIsSimultaneous	Specifies whether to update all channels in the task simultaneously, rather than updating channels independently when you write a sample to that channel.
	ReferenceClockRate	Specifies the frequency of the Reference Clock.
	ReferenceClockSource	Specifies the terminal of the signal to use as the Reference Clock.
	SampleClockActiveEdge	Specifies on which edge of a clock pulse sampling takes place. This property is useful primarily when the signal you use as the Sample Clock is not a periodic clock.
	SampleClockDigitalFilterEnable	Specifies whether to apply the pulse width filter to the signal.
	SampleClockDigitalFilterMinimumPulseWidth	Specifies in seconds the minimum pulse width the filter recognizes.
	SampleClockDigitalFilterTimebaseRate	Specifies in hertz the rate of the pulse width filter timebase. NI-DAQmx uses this value to compute settings for the filter.
	SampleClockDigitalFilterTimebaseSource	Specifies the input terminal of the signal to use as the timebase of the pulse width filter.
	SampleClockDigitalSynchronizationEnable	Specifies whether to synchronize recognition of transitions in the signal to the internal timebase of the device.
	SampleClockMaximumRate	Indicates the maximum Sample Clock rate supported by the task, based on other timing settings. For output tasks, the maximum Sample Clock rate is the maximum rate of the DAC. For input tasks, NI-DAQmx calculates the maximum sampling rate differently for multiplexed devices than simultaneous sampling devices.
	SampleClockOverrunBehavior	Specifies the action to take if Sample Clock edges occur faster than the device can handle them.
	SampleClockRate	Specifies the sampling rate in samples per channel per second. If you use an external source for the Sample Clock, set this input to the maximum expected rate of that clock.
	SampleClockSource	Specifies the terminal of the signal to use as the Sample Clock.
	SampleClockTerminal	Indicates the name of the internal Sample Clock terminal for the task. This property does not return the name of the Sample Clock source terminal specified with SampleClockSource.
	SampleClockTimebaseActiveEdge	Specifies on which edge to recognize a Sample Clock Timebase pulse. This property is useful primarily when the signal you use as the Sample Clock Timebase is not a periodic clock.
	SampleClockTimebaseDivisor	Specifies the number of Sample Clock Timebase pulses needed to produce a single Sample Clock pulse.
	SampleClockTimebaseMasterTimebaseDivisor	Specifies the number of pulses of the Master Timebase needed to produce a single pulse of the Sample Clock Timebase.
	SampleClockTimebaseRate	Specifies the rate of the Sample Clock Timebase. Some applications require that you specify a rate when you use any signal other than the onboard Sample Clock Timebase. NI-DAQmx requires this rate to calculate other timing parameters.
	SampleClockTimebaseSource	Specifies the terminal of the signal to use as the Sample Clock Timebase.
	SampleClockTimebaseTerminal	Indicates the name of the internal Sample Clock Timebase terminal for the task. This property does not return the name of the Sample Clock Timebase source terminal specified with SampleClockTimebaseSource.
	SampleClockTimingResponseMode	Obsolete. Specifies how the device responds to the sample clock and to triggers. This property has been deprecated in favor of the ConfigurePipelinedSampleClock(String, Double, SampleClockActiveEdge, SampleQuantityMode, Int32) method.
	SampleClockUnderflowBehavior	Specifies the action to take when the onboard memory of the device becomes empty. In either case, the sample clock does not stop.
	SampleQuantityMode	Specifies if a task acquires or generates a finite number of samples or if it continuously acquires or generates samples.
	SamplesPerChannel	Specifies the number of samples to acquire or generate for each channel if SampleQuantityMode is FiniteSamples. If SampleQuantityMode is ContinuousSamples, NI-DAQmx uses this value to determine the buffer size.
	SampleTimingEngine	Specifies which timing engine to use for the task.
	SampleTimingType	Specifies the type of sample timing to use for the task.
	SinglePoint	Gets an instance of SinglePoint.
	SynchronizationClockInterval	Specifies the interval, in Sample Clock periods, between each internal Synchronization Clock pulse. NI-DAQmx uses this pulse for synchronization of triggers between multiple devices at different rates. Refer to device documentation for information about how to calculate this value.
	SynchronizationPulseMinimumDelayToStart	Specifies in seconds the amount of time that elapses after the master device issues the synchronization pulse before the task starts.
	SynchronizationPulseResetDelay	Specifies in seconds the amount of time to wait after the Synchronization Pulse before resetting the ADCs or DACs on the device. When synchronizing devices, query SynchronizationPulseResetTime on all devices and note the largest reset time. Then, for each device, subtract the reset time from the largest reset time and set this property to the resulting value.
	SynchronizationPulseResetTime	Indicates in seconds the amount of time required for the ADCs or DACs on the device to reset. When synchronizing devices, query this property on all devices and note the largest reset time. Then, for each device, subtract the value of this property from the largest reset time and set SynchronizationPulseResetDelay to the resulting value.
	SynchronizationPulseSource	Specifies the terminal of the signal to use as the synchronization pulse. The synchronization pulse resets the clock dividers and the ADCs/DACs on the device.
	SynchronizationPulseTerminal	Indicates the name of the internal Synchronization Pulse terminal for the task. This property does not return the name of the source terminal.
	SynchronizationPulseTime	Indicates in seconds the delay required to reset the ADCs/DACs after the device receives the synchronization pulse.
	SynchronizationPulseTimescale	Specifies the timescale to be used for timestamps for a sync pulse.
	SynchronizationPulseTriggerTime	Gets or sets the start time of the synchronization pulse.
	SynchronizationPulseType	Specifies the type of sync pulse used in the task.

Top

Methods

	Name	Description
	ConfigureChangeDetection(String, String, SampleQuantityMode)	Configures the task to acquire samples on the rising and/or falling edges of the specified lines or ports.
	ConfigureChangeDetection(String, String, SampleQuantityMode, Int32)	Configures the task to acquire samples on the rising and/or falling edges of the specified lines or ports and sets the number of samples to acquire.
	ConfigureHandshaking(SampleQuantityMode)	Determines the sample timing and duration of the task using standard 8255/82C55 digital handshaking between the device and a peripheral device.
	ConfigureHandshaking(SampleQuantityMode, Int32)	Determines the sample timing and duration of the task with the specified number of samples, using standard 8255/82C55 digital handshaking between the device and a peripheral device.
	ConfigureHandshakingBurstExportClock	Determines when the DAQ device transfers data to a peripheral device, using the onboard sample clock of the DAQ device to control burst handshake timing and exporting that clock for use by the peripheral device.
	ConfigureHandshakingBurstImportClock	Determines when the DAQ device transfers data to a peripheral device, using an imported sample clock to control burst handshake timing.
	ConfigureImplicit(SampleQuantityMode)	Sets only the duration of the task without specifying timing.
	ConfigureImplicit(SampleQuantityMode, Int32)	Sets only the duration of the task and the number of samples to acquire or generate without specifying timing.
	ConfigurePipelinedSampleClock	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.
	ConfigureSampleClock(String, Double, SampleClockActiveEdge, SampleQuantityMode)	Sets the source of the sample clock and the rate of the sample clock.
	ConfigureSampleClock(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.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose	Releases the managed and unmanaged resources used by Task or optionally releases only the unmanaged resources.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ToString	Returns a string representation of the object. (Overrides ObjectToString.)

Top

Remarks

Tip
Example applications are located in the Public Documents\National Instruments\NI-DAQ\Examples\DotNET4.x directory or in the Start menu at National InstrumentsNI-DAQmxNI-DAQmx Examples.

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.

NI-DAQmx .NET Framework 4.0 API Reference

Filters

Content Type

Programming Language

Table of Contents

Timing Class

Timing Class

Inheritance Hierarchy

Syntax

Properties

Methods

Remarks

Thread Safety

See Also

Reference

In This Section

Additional Comments

Download PDF