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

Description

Functions for controlling burst mode.

By default burst mode is disabled (BM_DISABLED) and burst count is set to 1.

See also
Event Burst completed.

Functions

bool8_t GenIsBurstActive (TpDeviceHandle_t hDevice)
 Check whether burst is active. More...
 
uint64_t GenGetBurstCount (TpDeviceHandle_t hDevice)
 Get burst count. More...
 
uint64_t GenGetBurstCountMax (TpDeviceHandle_t hDevice)
 Get maximum burst count. More...
 
uint64_t GenSetBurstCount (TpDeviceHandle_t hDevice, uint64_t qwBurstCount)
 Set burst count. More...
 
uint64_t GenGetBurstModes (TpDeviceHandle_t hDevice)
 Get supported generator burst modes. More...
 
uint64_t GenGetBurstMode (TpDeviceHandle_t hDevice)
 Get generator burst mode. More...
 
uint64_t GenSetBurstMode (TpDeviceHandle_t hDevice, uint64_t qwBurstMode)
 Set generator burst mode. More...
 

Function Documentation

bool8_t GenIsBurstActive ( TpDeviceHandle_t  hDevice)

Check whether burst is active.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if active, BOOL8_FALSE otherwise.
Since
0.4.0
uint64_t GenGetBurstCount ( TpDeviceHandle_t  hDevice)

Get burst count.

Parameters
hDeviceA device handle.
Returns
Burst count.
Since
0.4.0
uint64_t GenGetBurstCountMax ( TpDeviceHandle_t  hDevice)

Get maximum burst count.

Parameters
hDeviceA device handle.
Returns
Maximum burst count.
Since
0.4.0
uint64_t GenSetBurstCount ( TpDeviceHandle_t  hDevice,
uint64_t  qwBurstCount 
)

Set burst count.

Parameters
hDeviceA device handle.
qwBurstCountBurst count, 0 to GenGetBurstCountMax().
Returns
Burst count.
Remarks
The new value becomes active after a call to GenStart().
Since
0.4.0
uint64_t GenGetBurstModes ( TpDeviceHandle_t  hDevice)

Get supported generator burst modes.

Parameters
hDeviceA device handle.
Returns
Supported generator burst modes, a set of OR-ed BM_* values.
Since
0.4.1
uint64_t GenGetBurstMode ( TpDeviceHandle_t  hDevice)

Get generator burst mode.

Parameters
hDeviceA device handle.
Returns
Generator burst mode, a BM_* value.
Since
0.4.1
uint64_t GenSetBurstMode ( TpDeviceHandle_t  hDevice,
uint64_t  qwBurstMode 
)

Set generator burst mode.

Parameters
hDeviceA device handle.
qwBurstModeGenerator burst mode, a BM_* value.
Returns
Generator burst mode, a BM_* value.
Remarks
The new value becomes active after a call to GenStart().
Since
0.4.1