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:

GM_BURST_COUNT : When the generator is started, or when an external trigger is enabled and the external signal becomes active, the generator generates a specified number of periods of the selected signal. When the required number of periods is reached, the generator stops automatically and the output will go to the selected Offset. When the burst is started again, the requested amount of periods is generated again.
GM_BURST_SAMPLE_COUNT : When the generator is started and the external signal becomes active, the generator generates a specified number of samples from the waveform buffer. When the required number of samples is reached, the generator automatically stops and the output will go to the selected Offset. When the burst is started again, the next requested amount of samples from the waveform buffer are generated.
GM_BURST_SAMPLE_COUNT_OUTPUT : When the generator is started and the external signal becomes active, the generator generates a specified number of samples from the waveform buffer. When the required number of samples is reached, the generator automatically stops and the output will remain at the level of the last generated sample. When the burst is started again, the next requested amount of samples from the waveform buffer are generated.
GM_BURST_SEGMENT_COUNT : The signal pattern buffer is divided in a specified number of segments. When the generator is started, each time the external signal becomes active, the generator generates the next segment, after which the generator automatically stops and the output will go to the selected Offset. When all sements have been generated, the generator will start on the first segment again, on the next activation of the external signal.
GM_BURST_SEGMENT_COUNT_OUTPUT : When the generator is started, each time the external signal becomes active, the generator generates the next segment, after which the generator automatically stops and the output will remain at the level of the last generated sample. When all sements have been generated, the generator will start on the first segment again, on the next activation of the external signal.

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

Functions
bool8_t	GenIsBurstActive (TpDeviceHandle_t hDevice)
	Check whether a burst is active, of a specified generator. More...

uint64_t	GenGetBurstCountMin (TpDeviceHandle_t hDevice)
	Get the minimum burst count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstCountMax (TpDeviceHandle_t hDevice)
	Get the maximum burst count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstCount (TpDeviceHandle_t hDevice)
	Get the current burst count for the current generator mode of a specified generator. More...

uint64_t	GenSetBurstCount (TpDeviceHandle_t hDevice, uint64_t qwBurstCount)
	Set the burst count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstSampleCountMin (TpDeviceHandle_t hDevice)
	Get the minimum burst sample count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstSampleCountMax (TpDeviceHandle_t hDevice)
	Get the maximum burst sample count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstSampleCount (TpDeviceHandle_t hDevice)
	Get the current burst sample count for the current generator mode of a specified generator. More...

uint64_t	GenSetBurstSampleCount (TpDeviceHandle_t hDevice, uint64_t qwBurstSampleCount)
	Set the burst sample count for the current generator mode of a specified generator. More...

uint64_t	GenGetBurstSegmentCountMin (TpDeviceHandle_t hDevice)
	Get the minimum burst segment count for the current settings of a specified generator. More...

uint64_t	GenGetBurstSegmentCountMax (TpDeviceHandle_t hDevice)
	Get the maximum burst segment count for the current settings of a specified generator. More...

uint64_t	GenGetBurstSegmentCount (TpDeviceHandle_t hDevice)
	Get the current burst segment count of a specified generator. More...

uint64_t	GenSetBurstSegmentCount (TpDeviceHandle_t hDevice, uint64_t qwBurstSegmentCount)
	Set the burst segment count of a specified generator. More...

Function Documentation

bool8_t GenIsBurstActive ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: Notification Burst completed.

Since: 0.4.0

uint64_t GenGetBurstCountMin ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstCountMax; GenGetBurstCount; GenSetBurstCount

Since: 0.5

uint64_t GenGetBurstCountMax ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstCountMin; GenGetBurstCount; GenSetBurstCount

Since: 0.4.0

uint64_t GenGetBurstCount ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstCountMax; GenGetBurstCountMin; GenSetBurstCount

Since: 0.4.0

uint64_t GenSetBurstCount	(	TpDeviceHandle_t	hDevice,
		uint64_t	qwBurstCount
	)

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

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	qwBurstCount	The 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstCountMax; GenGetBurstCountMin; GenGetBurstCount

Since: 0.4.0

uint64_t GenGetBurstSampleCountMin ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSampleCountMax; GenGetBurstSampleCount; GenSetBurstSampleCount

Since: 0.5

uint64_t GenGetBurstSampleCountMax ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSampleCountMin; GenGetBurstSampleCount; GenSetBurstSampleCount

Since: 0.5

uint64_t GenGetBurstSampleCount ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSampleCountMin; GenGetBurstSampleCountMax; GenSetBurstSampleCount

Since: 0.5

uint64_t GenSetBurstSampleCount	(	TpDeviceHandle_t	hDevice,
		uint64_t	qwBurstSampleCount
	)

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

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	qwBurstSampleCount	The 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSampleCountMin; GenGetBurstSampleCountMax; GenGetBurstSampleCount

Since: 0.5

uint64_t GenGetBurstSegmentCountMin ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSegmentCountMax; GenGetBurstSegmentCount; GenSetBurstSegmentCount

Since: 0.5

uint64_t GenGetBurstSegmentCountMax ( TpDeviceHandle_t hDevice )

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

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSegmentCountMin; GenGetBurstSegmentCount; GenSetBurstSegmentCount

Since: 0.5

uint64_t GenGetBurstSegmentCount ( TpDeviceHandle_t hDevice )

Get the current burst segment count of a specified generator.

Parameters

[in] hDevice A 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSegmentCountMin; GenGetBurstSegmentCountMax; GenSetBurstSegmentCount

Since: 0.5

uint64_t GenSetBurstSegmentCount	(	TpDeviceHandle_t	hDevice,
		uint64_t	qwBurstSegmentCount
	)

Set the burst segment count of a specified generator.

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	qwBurstSegmentCount	The 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.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetBurstSegmentCountMin; GenGetBurstSegmentCountMax; GenGetBurstSegmentCount

Since: 0.5