LibTiePie  0.4.1
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Groups Pages
Trigger system

Functions

double ScpGetTriggerTimeOut (TpDeviceHandle_t hDevice)
 Get trigger timeout in seconds.
 
double ScpSetTriggerTimeOut (TpDeviceHandle_t hDevice, double dTimeout)
 Set trigger timeout in seconds.
 
double ScpVerifyTriggerTimeOut (TpDeviceHandle_t hDevice, double dTimeout)
 Verify trigger timeout in seconds.
 
uint64_t ScpGetTriggerSources (TpDeviceHandle_t hDevice)
 Get supported trigger sources.
 
uint64_t ScpGetTriggerSourcesEx (TpDeviceHandle_t hDevice, uint32_t dwMeasureMode)
 Get supported trigger sources by measure mode.
 
uint64_t ScpGetTriggerSourceOR (TpDeviceHandle_t hDevice)
 Get trigger sources OR.
 
uint64_t ScpSetTriggerSourceOR (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask)
 Set trigger sources OR.
 
uint64_t ScpGetTriggerSourceAND (TpDeviceHandle_t hDevice)
 Set trigger sources AND.
 
uint64_t ScpSetTriggerSourceAND (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask)
 Get trigger sources AND.
 
uint64_t ScpGetTriggerKinds (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask)
 Get supported trigger kinds by source(s).
 
uint64_t ScpGetTriggerKindsEx (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask, uint32_t dwMeasureMode)
 Get supported trigger kinds by source(s) and measure mode.
 
uint64_t ScpGetTriggerKind (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource)
 Get trigger kind.
 
uint64_t ScpSetTriggerKind (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource, uint64_t qwTriggerKind)
 Set trigger kind.
 
double ScpGetTriggerLevel (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource, uint32_t dwIndex)
 Get trigger level.
 
double ScpSetTriggerLevel (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource, uint32_t dwIndex, double dLevel)
 Set trigger level.
 
double ScpGetTriggerHysteresis (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource, uint32_t dwIndex)
 Get trigger hysteresis.
 
double ScpSetTriggerHysteresis (TpDeviceHandle_t hDevice, uint64_t qwTriggerSource, uint32_t dwIndex, double dHysteresis)
 Set trigger hysteresis.
 
uint64_t ScpChGetTriggerKinds (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get supported channel trigger kinds.
 
uint64_t ScpChGetTriggerKindsEx (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwMeasureMode)
 Get supported channel trigger kinds by measure mode.
 
uint64_t ScpChGetTriggerKind (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get channel trigger kind.
 
uint64_t ScpChSetTriggerKind (TpDeviceHandle_t hDevice, uint16_t wCh, uint64_t qwTriggerKind)
 Set channel trigger kind.
 
double ScpChGetTriggerLevel (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get channel trigger level.
 
double ScpChSetTriggerLevel (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dLevel)
 Set channel trigger level.
 
double ScpChGetTriggerHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get channel trigger hysteresis.
 
double ScpChSetTriggerHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dHysteresis)
 Set channel trigger hysteresis.
 
double ScpChGetTriggerPulseTime (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get channel trigger pulse time.
 
double ScpChSetTriggerPulseTime (TpDeviceHandle_t hDevice, uint16_t wCh, double dPulseTime)
 Set channel trigger pulse time.
 

Detailed Description

Function Documentation

double ScpChGetTriggerHysteresis ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex 
)

Get channel trigger hysteresis.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetHysteresis().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index.
Returns
Trigger hysteresis, 0..1.
uint64_t ScpChGetTriggerKind ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get channel trigger kind.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetKind().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
A TK_* value.
uint64_t ScpChGetTriggerKinds ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get supported channel trigger kinds.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetKinds().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Supported trigger kinds, a set of OR-ed TK_* values.
uint64_t ScpChGetTriggerKindsEx ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwMeasureMode 
)

Get supported channel trigger kinds by measure mode.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetKindsEx().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dwMeasureModeMeasure mode, a MM_* value.
Returns
Supported trigger kinds, a set of OR-ed TK_* values.
double ScpChGetTriggerLevel ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex 
)

Get channel trigger level.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetLevel().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index.
Returns
Trigger level, 0..1.
double ScpChGetTriggerPulseTime ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get channel trigger pulse time.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrGetTime().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Trigger pulse time in seconds.
double ScpChSetTriggerHysteresis ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex,
double  dHysteresis 
)

Set channel trigger hysteresis.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrSetHysteresis().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index.
dHysteresisTrigger hysteresis, 0..1.
Returns
Trigger hysteresis, 0..1.
uint64_t ScpChSetTriggerKind ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint64_t  qwTriggerKind 
)

Set channel trigger kind.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrSetKind().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
qwTriggerKindTrigger kind: a TK_* value.
Returns
A TK_* value.
double ScpChSetTriggerLevel ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
uint32_t  dwIndex,
double  dLevel 
)

Set channel trigger level.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrSetLevel().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dwIndexTrigger hysteresis index.
dLevelTrigger level, 0..1.
Returns
Trigger level, 0..1.
double ScpChSetTriggerPulseTime ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
double  dPulseTime 
)

Set channel trigger pulse time.

Deprecated:
Will be removed in LibTiePie 0.5.0, use: ScpChTrSetTime().
Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
dPulseTimeTrigger pulse time in seconds.
Returns
Trigger pulse time in seconds.
double ScpGetTriggerHysteresis ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource,
uint32_t  dwIndex 
)

Get trigger hysteresis.

Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
dwIndexTrigger hysteresis index.
Returns
Trigger hysteresis, 0..1.
uint64_t ScpGetTriggerKind ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource 
)

Get trigger kind.

Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
Returns
A TK_* value.
uint64_t ScpGetTriggerKinds ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask 
)

Get supported trigger kinds by source(s).

When getting supported trigger kinds of multiple sources the result is a set of OR-ed TK_* values which are supported by all sources.

Parameters
hDeviceA device handle.
qwTriggerSourceMaskA TS_* value or multiple OR-ed TS_* values.
Returns
Supported trigger kinds, a set of OR-ed TK_* values.
uint64_t ScpGetTriggerKindsEx ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask,
uint32_t  dwMeasureMode 
)

Get supported trigger kinds by source(s) and measure mode.

When getting supported trigger kinds of multiple sources the result is a set of OR-ed TK_* values which are supported by all sources.

Parameters
hDeviceA device handle.
qwTriggerSourceMaskTS_* value or multiple OR-ed TS_* values.
dwMeasureModeMeasure mode, a MM_* value.
Returns
Supported trigger kinds, a set of OR-ed TK_* values.
double ScpGetTriggerLevel ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource,
uint32_t  dwIndex 
)

Get trigger level.

Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
dwIndexTrigger level index.
Returns
Trigger level, 0..1.
uint64_t ScpGetTriggerSourceAND ( TpDeviceHandle_t  hDevice)

Set trigger sources AND.

Parameters
hDeviceA device handle.
Returns
Trigger sources, a set of OR-ed TS_* values.
uint64_t ScpGetTriggerSourceOR ( TpDeviceHandle_t  hDevice)

Get trigger sources OR.

Parameters
hDeviceA device handle.
Returns
Trigger sources, a set of OR-ed TS_* values.
uint64_t ScpGetTriggerSources ( TpDeviceHandle_t  hDevice)

Get supported trigger sources.

Parameters
hDeviceA device handle.
Returns
Supported trigger sources, a set of OR-ed TS_* values.
uint64_t ScpGetTriggerSourcesEx ( TpDeviceHandle_t  hDevice,
uint32_t  dwMeasureMode 
)

Get supported trigger sources by measure mode.

Parameters
hDeviceA device handle.
dwMeasureModeMeasure mode, a MM_* value.
Returns
Supported trigger sources by measure mode, a set of OR-ed TS_* values.
double ScpGetTriggerTimeOut ( TpDeviceHandle_t  hDevice)

Get trigger timeout in seconds.

Parameters
hDeviceA device handle.
Returns
Trigger timeout in seconds or TO_INFINITY.
double ScpSetTriggerHysteresis ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource,
uint32_t  dwIndex,
double  dHysteresis 
)

Set trigger hysteresis.

Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
dwIndexTrigger hysteresis index.
dHysteresisTrigger hysteresis, 0..1.
Returns
Trigger hysteresis, 0..1.
uint64_t ScpSetTriggerKind ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource,
uint64_t  qwTriggerKind 
)

Set trigger kind.

See Also
Trigger kinds
Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
qwTriggerKindTrigger kind: a TK_* value.
Returns
A TK_* value.
double ScpSetTriggerLevel ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSource,
uint32_t  dwIndex,
double  dLevel 
)

Set trigger level.

Parameters
hDeviceA device handle.
qwTriggerSourceA TS_* value.
dwIndexTrigger level index.
dLevelTrigger level, 0..1.
Returns
Trigger level, 0..1.
uint64_t ScpSetTriggerSourceAND ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask 
)

Get trigger sources AND.

Parameters
hDeviceA device handle.
qwTriggerSourceMaskTrigger sources, a set of OR-ed TS_* values.
Returns
Trigger sources, a set of OR-ed TS_* values.
uint64_t ScpSetTriggerSourceOR ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask 
)

Set trigger sources OR.

Parameters
hDeviceA device handle.
qwTriggerSourceMaskTrigger sources, a set of OR-ed TS_* values.
Returns
Trigger sources, a set of OR-ed TS_* values.
double ScpSetTriggerTimeOut ( TpDeviceHandle_t  hDevice,
double  dTimeout 
)

Set trigger timeout in seconds.

Parameters
hDeviceA device handle.
dTimeoutTrigger timeout in seconds or TO_INFINITY.
Returns
Trigger timeout in seconds or TO_INFINITY.
double ScpVerifyTriggerTimeOut ( TpDeviceHandle_t  hDevice,
double  dTimeout 
)

Verify trigger timeout in seconds.

Parameters
hDeviceA device handle.
dTimeoutTrigger timeout in seconds or TO_INFINITY.
Returns
Trigger timeout in seconds or TO_INFINITY.