ReferenceTrigger Class
- Updated2023-02-21
- 7 minute(s) read
Contains properties and methods that configure the trigger that creates the reference point between the pretrigger samples and the post-trigger samples.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
NationalInstruments.DAQmxReferenceTrigger
SystemMarshalByRefObject
NationalInstruments.DAQmxReferenceTrigger
Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.45.49302
Syntax
public class ReferenceTrigger : MarshalByRefObject, IFilteredTypeDescriptor
Public Class ReferenceTrigger Inherits MarshalByRefObject Implements IFilteredTypeDescriptor
The ReferenceTrigger type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AnalogEdge | Gets the AnalogEdgeReferenceTrigger. |
| AnalogMultiEdge | Gets the AnalogMultiEdgeReferenceTrigger. |
| AnalogWindow | Gets the AnalogWindowReferenceTrigger. |
| AutoTriggered | Indicates whether a completed acquisition was triggered by the auto trigger. If an acquisition has not completed after the task starts, this property returns . This property is only applicable when AutoTriggerEnable is . |
| AutoTriggerEnable | Specifies whether to send a software trigger to the device when a hardware trigger is no longer active in order to prevent a timeout. |
| Delay | Specifies in seconds the time to wait after the device receives the Reference Trigger before switching from pretrigger to posttrigger samples. |
| DigitalEdge | Gets the DigitalEdgeReferenceTrigger. |
| DigitalPattern | Gets the DigitalPatternReferenceTrigger. |
| MaximumNumberOfTriggersToDetect | Specifies the maximum number of times the task will detect a reference trigger during the task. The number of times a trigger is detected and acted upon by the module may be less than the specified amount if the task stops early because of trigger/retrigger window expiration. Specifying the Maximum Number of Triggers to Detect to be 0 causes the driver to automatically set this value to the maximum possible number of triggers detectable by the device and configuration combination. Note: The number of detected triggers may be less than number of trigger events occurring, because the devices were unable to respond to the trigger. |
| PretriggerSamples | Specifies the minimum number of pretrigger samples to acquire from each channel before recognizing the reference trigger. Post-trigger samples per channel are equal to SamplesPerChannel minus the number of pretrigger samples per channel. |
| Retriggerable | Specifies whether a finite task resets, acquires pretrigger samples, and waits for another Reference Trigger after the task completes. When you set this property to TRUE, the device will acquire post-trigger samples, reset, and acquire pretrigger samples each time the Reference Trigger occurs until the task stops. The device ignores a trigger if it is in the process of acquiring signals. |
| RetriggerWindow | Specifies the duration in seconds after each trigger during which the device may trigger. Once the window has passed, the device stops detecting triggers, and the task will stop after the device finishes acquiring post-trigger samples that it already started. Specifying a Retrigger Window of -1 causes the window to be infinite. |
| Terminal | Indicates the name of the internal Reference Trigger terminal for the task. This property does not return the name of the trigger source terminal. |
| Timestamp | Gets the reference trigger timestamp. |
| TimestampEnable | Specifies whether the reference trigger timestamp is enabled. If the timestamp is enabled but no resources are available, an error will be returned at run time. |
| TimestampTimescale | Specifies the reference trigger timestamp timescale. |
| TriggerWindow | Specifies the duration in seconds after the task starts during which the device may trigger. Once the window has passed, the device stops detecting triggers, and the task will stop after the device finishes acquiring post-trigger samples that it already started. If no triggers are detected during the entire period, then no data will be returned. Specifying a Trigger Window of -1 causes the window to be infinite. |
| Type |
Methods
| Name | Description | |
|---|---|---|
 | ConfigureAnalogEdgeTrigger | Configures the task to stop the acquisition when the device acquires all pretrigger samples; an analog signal reaches the level you specify; and the device acquires all post-trigger samples. |
| ConfigureAnalogMultiEdgeTrigger |
Configures the task to stop the acquisition when the device acquires all pretrigger samples, any of the configured analog signals reaches the levels you specify, and the device acquires all post-trigger samples.
|
| ConfigureAnalogWindowTrigger | Configures the task to stop the acquisition when the device acquires all pretrigger samples; an analog signal enters or leaves a range you specify; and the device acquires all post-trigger samples.
|
| ConfigureDigitalEdgeTrigger | Configures the task to stop the acquisition when the device acquires all pretrigger samples, detects a rising or falling edge of a digital signal, and acquires all post-trigger samples. |
| ConfigureDigitalPatternTrigger | Configures a task to stop the acquisition when the device acquires all pretrigger samples, matches a digital pattern, and acquires all posttrigger samples. |
| ConfigureNone | Disables reference triggering for the measurement. |
| 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.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (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.) |
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.