LibTiePie  0.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages

Description

The Time property determines how long a specific condition must last for the channel trigger to respond.

The number of time properties depends on the currently selected trigger kind and currently selected trigger condition. Use ScpChTrGetTimeCount() to determine the number of trigger time properties for the currently set trigger kind and condition.

The trigger time can be affected by changing the sample frequency.

The trigger time is set as a value in seconds. By default time[0] is set to 1 ms.

Functions

uint32_t ScpChTrGetTimeCount (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the number of trigger times for the current trigger kind and trigger condition. More...
 
double ScpChTrGetTime (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the current trigger time value for a specified channel and trigger type. More...
 
double ScpChTrSetTime (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dTime)
 Set the required trigger time value for a specified channel and trigger type. More...
 

Function Documentation

uint32_t ScpChTrGetTimeCount ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get the number of trigger times for the current trigger kind and trigger condition.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
The number of available trigger times for the current trigger kind and condition.
Status values
NOT_SUPPORTED The indicated channel does not support trigger with the current settings.
INVALID_CHANNEL The requested channel number is not valid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetKind
ScpChTrGetCondition
ScpChTrGetTime
ScpChTrSetTime
Since
0.4.1
double ScpChTrGetTime ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex 
)

Get the current trigger time value for a specified channel and trigger type.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]dwIndexThe trigger time index, 0 to ScpChTrGetTimeCount() - 1.
Returns
The currently set trigger time value, in seconds.
Status values
NOT_SUPPORTED The indicated channel does not support trigger (time) with the current settings.
INVALID_INDEX The trigger time index is invalid.
INVALID_CHANNEL The requested channel number is not valid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetTimeCount
ScpChTrSetTime
Since
0.4.1
double ScpChTrSetTime ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex,
double  dTime 
)

Set the required trigger time value for a specified channel and trigger type.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
[in]dwIndexThe trigger time index, 0 to ScpChTrGetTimeCount() - 1.
[in]dTimeThe required trigger time value, in seconds.
Returns
The actually set trigger time value, in seconds.
Status values
VALUE_MODIFIED The requested trigger time is within the valid range, but not available. The closest valid value is set.
INVALID_VALUE The requested trigger time is invalid.
INVALID_INDEX The trigger time index is invalid.
NOT_SUPPORTED The indicated channel does not support trigger (time) with the current settings.
INVALID_CHANNEL The requested channel number is not valid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
ScpChTrGetTimeCount
ScpChTrGetTime
Since
0.4.1