LibTiePie  0.7.1
Library for interfacing TiePie engineering instruments

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 ScpHasTriggerDelay() 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 frequency.

Functions

bool8_t ScpHasTriggerDelay (LibTiePieHandle_t hDevice)
 Check whether the oscilloscope has trigger delay support with the currently selected measure mode. More...
 
double ScpGetTriggerDelayMax (LibTiePieHandle_t hDevice)
 Get the maximum trigger delay in seconds, for the currently selected measure mode and sample frequency. More...
 
double ScpGetTriggerDelay (LibTiePieHandle_t hDevice)
 Get the currently selected trigger delay in seconds, for a specified oscilloscope. More...
 
double ScpSetTriggerDelay (LibTiePieHandle_t hDevice, double dDelay)
 Set trigger delay in seconds, for a specified oscilloscope. More...
 

Function Documentation

bool8_t ScpHasTriggerDelay ( LibTiePieHandle_t  hDevice)

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

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
BOOL8_TRUE if the oscilloscope has trigger delay support, BOOL8_FALSE otherwise.
Status values
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.5
double ScpGetTriggerDelayMax ( LibTiePieHandle_t  hDevice)

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

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
The maximum trigger delay in seconds.
Status values
NOT_SUPPORTED The oscilloscope does not support trigger delay.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpHasTriggerDelay
ScpGetTriggerDelay
ScpSetTriggerDelay
Since
0.5
double ScpGetTriggerDelay ( LibTiePieHandle_t  hDevice)

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

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
The currently set trigger delay in seconds.
Status values
NOT_SUPPORTED The oscilloscope does not support trigger delay.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpHasTriggerDelay
ScpGetTriggerDelayMax
ScpSetTriggerDelay
Since
0.4.3
double ScpSetTriggerDelay ( LibTiePieHandle_t  hDevice,
double  dDelay 
)

Set trigger delay in seconds, for a specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]dDelayThe required trigger delay in seconds.
Returns
The actually set trigger delay in seconds.
Status values
VALUE_MODIFIED The requested trigger delay is within the valid range but not available. The closest valid value is set.
INVALID_VALUE The requested value is invalid.
NOT_SUPPORTED The oscilloscope does not support trigger delay.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpHasTriggerDelay
ScpGetTriggerDelayMax
ScpGetTriggerDelay
Since
0.4.3