libtiepie-hw  1.1.6

Functions to control the trigger delay of an oscilloscope. More...

Collaboration diagram for Delay:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_trigger_has_delay (tiepie_hw_handle handle)
 Check whether the oscilloscope has trigger delay support with the currently selected measure mode. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_delay_max (tiepie_hw_handle handle)
 Get the maximum trigger delay in seconds, for the currently selected measure mode and sample rate. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_delay (tiepie_hw_handle handle)
 Get the currently selected trigger delay in seconds, for a specified oscilloscope. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_set_delay (tiepie_hw_handle handle, double value)
 Set trigger delay in seconds, for a specified oscilloscope. More...
 

Detailed Description

Functions to control the trigger delay of an oscilloscope.

Trigger delay allows to start measuring a specified time after the trigger occurred. This allows to capture events that are more than one full record length past the trigger moment.

Trigger delay is not available for all instruments and only available in measure mode Block. Use tiepie_hw_oscilloscope_trigger_has_delay() to check whether trigger delay is available for your instrument and in the currently set measure mode.

The trigger delay can be affected by changing the sample rate.

Function Documentation

◆ tiepie_hw_oscilloscope_trigger_has_delay()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_trigger_has_delay ( tiepie_hw_handle  handle)

Check whether the oscilloscope has trigger delay support with the currently selected measure mode.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if the oscilloscope has trigger delay support, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_oscilloscope_trigger_get_delay_max()

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_delay_max ( tiepie_hw_handle  handle)

Get the maximum trigger delay in seconds, for the currently selected measure mode and sample rate.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The maximum trigger delay in seconds.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support trigger delay.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_trigger_has_delay
tiepie_hw_oscilloscope_trigger_get_delay
tiepie_hw_oscilloscope_trigger_set_delay
Since
1.0

◆ tiepie_hw_oscilloscope_trigger_get_delay()

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_get_delay ( tiepie_hw_handle  handle)

Get the currently selected trigger delay in seconds, for a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The currently set trigger delay in seconds.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support trigger delay.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_trigger_has_delay
tiepie_hw_oscilloscope_trigger_get_delay_max
tiepie_hw_oscilloscope_trigger_set_delay
Since
1.0

◆ tiepie_hw_oscilloscope_trigger_set_delay()

TIEPIE_HW_API double tiepie_hw_oscilloscope_trigger_set_delay ( tiepie_hw_handle  handle,
double  value 
)

Set trigger delay in seconds, for a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]valueThe required trigger delay in seconds.
Returns
The actually set trigger delay in seconds.
Status values
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested trigger delay is within the valid range but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support trigger delay.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_trigger_has_delay
tiepie_hw_oscilloscope_trigger_get_delay_max
tiepie_hw_oscilloscope_trigger_get_delay
Since
1.0