libtiepie-hw  1.2.5

Functions for controlling burst mode. More...

Collaboration diagram for Burst:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_is_burst_active (tiepie_hw_handle handle)
 Check whether a burst is active, of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count_min (tiepie_hw_handle handle)
 Get the minimum burst count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count_max (tiepie_hw_handle handle)
 Get the maximum burst count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count (tiepie_hw_handle handle)
 Get the current burst count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_count (tiepie_hw_handle handle, uint64_t value)
 Set the burst count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count_min (tiepie_hw_handle handle)
 Get the minimum burst sample count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count_max (tiepie_hw_handle handle)
 Get the maximum burst sample count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count (tiepie_hw_handle handle)
 Get the current burst sample count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_sample_count (tiepie_hw_handle handle, uint64_t value)
 Set the burst sample count for the current generator mode of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count_min (tiepie_hw_handle handle)
 Get the minimum burst segment count for the current settings of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count_max (tiepie_hw_handle handle)
 Get the maximum burst segment count for the current settings of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count (tiepie_hw_handle handle)
 Get the current burst segment count of a specified generator. More...
 
TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_segment_count (tiepie_hw_handle handle, uint64_t value)
 Set the burst segment count of a specified generator. More...
 

Detailed 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 tiepie_hw_generator_start() and via an external trigger signal on a selected generator trigger input. For all burst modes except TIEPIE_HW_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.

Function Documentation

◆ tiepie_hw_generator_is_burst_active()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_is_burst_active ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
TIEPIE_HW_BOOL_TRUE if a burst is active, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The current generator mode does not support getting the burst status.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
Notification gen_callbacks_burst_completed.
Since
1.0

◆ tiepie_hw_generator_get_burst_count_min()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count_min ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The minimum burst count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_count_max
tiepie_hw_generator_get_burst_count
tiepie_hw_generator_set_burst_count
Since
1.0

◆ tiepie_hw_generator_get_burst_count_max()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count_max ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The maximum burst count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_count_min
tiepie_hw_generator_get_burst_count
tiepie_hw_generator_set_burst_count
Since
1.0

◆ tiepie_hw_generator_get_burst_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_count ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The currently set burst count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_count_max
tiepie_hw_generator_get_burst_count_min
tiepie_hw_generator_set_burst_count
Since
1.0

◆ tiepie_hw_generator_set_burst_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_count ( tiepie_hw_handle  handle,
uint64_t  value 
)

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

Parameters
[in]handleA device handle identifying the generator.
[in]valueThe requested burst count, Gen_get_burst_count_min() to Gen_get_burst_count_max().
Returns
The actually set burst count.
Remarks
The new value becomes active after a call to tiepie_hw_generator_start().
Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested burst count is outside the valid range and clipped to that range.
TIEPIE_HW_STATUS_INVALID_VALUE The requested burst count is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_count_max
tiepie_hw_generator_get_burst_count_min
tiepie_hw_generator_get_burst_count
Since
1.0

◆ tiepie_hw_generator_get_burst_sample_count_min()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count_min ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The minimum burst sample count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_sample_count_max
tiepie_hw_generator_get_burst_sample_count
tiepie_hw_generator_set_burst_sample_count
Since
1.0

◆ tiepie_hw_generator_get_burst_sample_count_max()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count_max ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The maximum burst sample count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_sample_count_min
tiepie_hw_generator_get_burst_sample_count
tiepie_hw_generator_set_burst_sample_count
Since
1.0

◆ tiepie_hw_generator_get_burst_sample_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_sample_count ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The currently set burst sample count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_sample_count_min
tiepie_hw_generator_get_burst_sample_count_max
tiepie_hw_generator_set_burst_sample_count
Since
1.0

◆ tiepie_hw_generator_set_burst_sample_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_sample_count ( tiepie_hw_handle  handle,
uint64_t  value 
)

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

Parameters
[in]handleA device handle identifying the generator.
[in]valueThe requested burst sample count, Gen_getburst_sample_count_min() to Gen_getburst_sample_count_max().
Returns
The actually set burst sample count.
Remarks
The new value becomes active after a call to tiepie_hw_generator_start().
Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested burst sample count is outside the valid range and clipped to that range.
TIEPIE_HW_STATUS_INVALID_VALUE The requested burst sample count is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst sample count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_sample_count_min
tiepie_hw_generator_get_burst_sample_count_max
tiepie_hw_generator_get_burst_sample_count
Since
1.0

◆ tiepie_hw_generator_get_burst_segment_count_min()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count_min ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The minimum burst segment count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_segment_count_max
tiepie_hw_generator_get_burst_segment_count
tiepie_hw_generator_set_burst_segment_count
Since
1.0

◆ tiepie_hw_generator_get_burst_segment_count_max()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count_max ( tiepie_hw_handle  handle)

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

Parameters
[in]handleA device handle identifying the generator.
Returns
The maximum burst segment count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_segment_count_min
tiepie_hw_generator_get_burst_segment_count
tiepie_hw_generator_set_burst_segment_count
Since
1.0

◆ tiepie_hw_generator_get_burst_segment_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_get_burst_segment_count ( tiepie_hw_handle  handle)

Get the current burst segment count of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
Returns
The currently set burst segment count.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_segment_count_min
tiepie_hw_generator_get_burst_segment_count_max
tiepie_hw_generator_set_burst_segment_count
Since
1.0

◆ tiepie_hw_generator_set_burst_segment_count()

TIEPIE_HW_API uint64_t tiepie_hw_generator_set_burst_segment_count ( tiepie_hw_handle  handle,
uint64_t  value 
)

Set the burst segment count of a specified generator.

Parameters
[in]handleA device handle identifying the generator.
[in]valueThe requested burst segment count, tiepie_hw_generator_get_burst_segment_count_min() to tiepie_hw_generator_get_burst_segment_count_max().
Returns
The actually set burst segment count.
Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested burst segment count is outside the valid range and clipped to that range.
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested burst sample count is inside the valid range but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE The requested burst segment count is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED The generator does not support burst segment count in the current generator mode.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_generator_get_burst_segment_count_min
tiepie_hw_generator_get_burst_segment_count_max
tiepie_hw_generator_get_burst_segment_count
Since
1.0