LibTiePie  0.9.8
Library for interfacing TiePie engineering instruments

Description

Functions for controlling burst mode.

In burst mode, the generator generates a specified number of periods of the selected signal, a specified number of samples from the waveform buffer or a segement from the waveform buffer and then stops automatically.

Starting the generator is done using GenStart() and via an external trigger signal on a selected generator trigger input. For all burst modes except GM_BURST_COUNT a generator trigger input must be enabled.

The following burst modes are supported:

By default burst count, burst sample count and burst segment count are set to their minimum values.

Functions

bool8_t GenIsBurstActive (LibTiePieHandle_t hDevice)
 Check whether a burst is active, of a specified generator. More...
 
uint64_t GenGetBurstCountMin (LibTiePieHandle_t hDevice)
 Get the minimum burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstCountMax (LibTiePieHandle_t hDevice)
 Get the maximum burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstCount (LibTiePieHandle_t hDevice)
 Get the current burst count for the current generator mode of a specified generator. More...
 
uint64_t GenSetBurstCount (LibTiePieHandle_t hDevice, uint64_t qwBurstCount)
 Set the burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCountMin (LibTiePieHandle_t hDevice)
 Get the minimum burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCountMax (LibTiePieHandle_t hDevice)
 Get the maximum burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCount (LibTiePieHandle_t hDevice)
 Get the current burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenSetBurstSampleCount (LibTiePieHandle_t hDevice, uint64_t qwBurstSampleCount)
 Set the burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSegmentCountMin (LibTiePieHandle_t hDevice)
 Get the minimum burst segment count for the current settings of a specified generator. More...
 
uint64_t GenGetBurstSegmentCountMax (LibTiePieHandle_t hDevice)
 Get the maximum burst segment count for the current settings of a specified generator. More...
 
uint64_t GenGetBurstSegmentCount (LibTiePieHandle_t hDevice)
 Get the current burst segment count of a specified generator. More...
 
uint64_t GenSetBurstSegmentCount (LibTiePieHandle_t hDevice, uint64_t qwBurstSegmentCount)
 Set the burst segment count of a specified generator. More...
 

Function Documentation

bool8_t GenIsBurstActive ( LibTiePieHandle_t  hDevice)

Check whether a burst is active, of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
BOOL8_TRUE if a burst is active, BOOL8_FALSE otherwise.
Status values
NOT_SUPPORTED The current generator mode does not support getting the burst status.
INVALID_HANDLE The handle is not a valid generator 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
Notification Burst completed.
Since
0.4.0
uint64_t GenGetBurstCountMin ( LibTiePieHandle_t  hDevice)

Get the minimum burst count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The minimum burst count.
Status values
NOT_SUPPORTED The generator does not support burst count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstCountMax
GenGetBurstCount
GenSetBurstCount
Since
0.5
uint64_t GenGetBurstCountMax ( LibTiePieHandle_t  hDevice)

Get the maximum burst count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The maximum burst count.
Status values
NOT_SUPPORTED The generator does not support burst count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstCountMin
GenGetBurstCount
GenSetBurstCount
Since
0.4.0
uint64_t GenGetBurstCount ( LibTiePieHandle_t  hDevice)

Get the current burst count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The currently set burst count.
Status values
NOT_SUPPORTED The generator does not support burst count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstCountMax
GenGetBurstCountMin
GenSetBurstCount
Since
0.4.0
uint64_t GenSetBurstCount ( LibTiePieHandle_t  hDevice,
uint64_t  qwBurstCount 
)

Set the burst count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
[in]qwBurstCountThe requested burst count, GenGetBurstCountMin() to GenGetBurstCountMax().
Returns
The actually set burst count.
Remarks
The new value becomes active after a call to GenStart().
Status values
VALUE_CLIPPED The requested burst count is outside the valid range and clipped to that range.
INVALID_VALUE The requested burst count is invalid.
NOT_SUPPORTED The generator does not support burst count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstCountMax
GenGetBurstCountMin
GenGetBurstCount
Since
0.4.0
uint64_t GenGetBurstSampleCountMin ( LibTiePieHandle_t  hDevice)

Get the minimum burst sample count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The minimum burst sample count.
Status values
NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSampleCountMax
GenGetBurstSampleCount
GenSetBurstSampleCount
Since
0.5
uint64_t GenGetBurstSampleCountMax ( LibTiePieHandle_t  hDevice)

Get the maximum burst sample count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The maximum burst sample count.
Status values
NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSampleCountMin
GenGetBurstSampleCount
GenSetBurstSampleCount
Since
0.5
uint64_t GenGetBurstSampleCount ( LibTiePieHandle_t  hDevice)

Get the current burst sample count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The currently set burst sample count.
Status values
NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSampleCountMin
GenGetBurstSampleCountMax
GenSetBurstSampleCount
Since
0.5
uint64_t GenSetBurstSampleCount ( LibTiePieHandle_t  hDevice,
uint64_t  qwBurstSampleCount 
)

Set the burst sample count for the current generator mode of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
[in]qwBurstSampleCountThe requested burst sample count, GenGetBurstSampleCountMin() to GenGetBurstSampleCountMax().
Returns
The actually set burst sample count.
Remarks
The new value becomes active after a call to GenStart().
Status values
VALUE_CLIPPED The requested burst sample count is outside the valid range and clipped to that range.
INVALID_VALUE The requested burst sample count is invalid.
NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSampleCountMin
GenGetBurstSampleCountMax
GenGetBurstSampleCount
Since
0.5
uint64_t GenGetBurstSegmentCountMin ( LibTiePieHandle_t  hDevice)

Get the minimum burst segment count for the current settings of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The minimum burst segment count.
Status values
NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSegmentCountMax
GenGetBurstSegmentCount
GenSetBurstSegmentCount
Since
0.5
uint64_t GenGetBurstSegmentCountMax ( LibTiePieHandle_t  hDevice)

Get the maximum burst segment count for the current settings of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The maximum burst segment count.
Status values
NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSegmentCountMin
GenGetBurstSegmentCount
GenSetBurstSegmentCount
Since
0.5
uint64_t GenGetBurstSegmentCount ( LibTiePieHandle_t  hDevice)

Get the current burst segment count of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The currently set burst segment count.
Status values
NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSegmentCountMin
GenGetBurstSegmentCountMax
GenSetBurstSegmentCount
Since
0.5
uint64_t GenSetBurstSegmentCount ( LibTiePieHandle_t  hDevice,
uint64_t  qwBurstSegmentCount 
)

Set the burst segment count of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
[in]qwBurstSegmentCountThe requested burst segment count, GenGetBurstSegmentCountMin() to GenGetBurstSegmentCountMax().
Returns
The actually set burst segment count.
Status values
VALUE_CLIPPED The requested burst segment count is outside the valid range and clipped to that range.
VALUE_MODIFIED The requested burst sample count is inside the valid range but not available. The closest valid value is set.
INVALID_VALUE The requested burst segment count is invalid.
NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
INVALID_HANDLE The handle is not a valid generator 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
GenGetBurstSegmentCountMin
GenGetBurstSegmentCountMax
GenGetBurstSegmentCount
Since
0.5