Functions to control the record length of the oscilloscope. More...

Collaboration diagram for Record length:

Functions
TIEPIE_HW_API uint64_t	tiepie_hw_oscilloscope_get_record_length_max (tiepie_hw_handle handle)
	Get the maximum supported record length of a specified oscilloscope.

TIEPIE_HW_API uint64_t	tiepie_hw_oscilloscope_get_record_length (tiepie_hw_handle handle)
	Get the currently selected record length of a specified oscilloscope.

TIEPIE_HW_API uint64_t	tiepie_hw_oscilloscope_set_record_length (tiepie_hw_handle handle, uint64_t record_length)
	Set the record length of a specified oscilloscope.

Detailed Description

Functions to control the record length of the oscilloscope.

The record length defines the number of samples in a measurement. With a given sample rate, the record length determines the duration of the measurement. Increasing the record length, will increase the total measuring time. The result is that more of the measured signal is visible.

The maximum supported record length depends on the used instrument and its configuration. Use tiepie_hw_oscilloscope_get_record_length_max to determine the maximum supported record length of a oscilloscope.

The record length can be affected by changing the channel enable, resolution, measure mode and/or sample rate.

By default the record length is set to: 5000 samples.

Function Documentation

◆ tiepie_hw_oscilloscope_get_record_length_max()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_get_record_length_max ( tiepie_hw_handle handle )

Get the maximum supported record length of a specified oscilloscope.

Parameters

[in] handle A device handle identifying the oscilloscope.

Returns: The maximum supported record length, or 0 when unsuccessful.

Status values

TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also: tiepie_hw_oscilloscope_get_record_length; tiepie_hw_oscilloscope_set_record_length

Since: 1.0

◆ tiepie_hw_oscilloscope_get_record_length()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_get_record_length ( tiepie_hw_handle handle )

Get the currently selected record length of a specified oscilloscope.

Parameters

[in] handle A device handle identifying the oscilloscope.

Returns: The currently selected record length in samples, or 0 when unsuccessful.

Status values

TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also: tiepie_hw_oscilloscope_get_record_length_max; tiepie_hw_oscilloscope_set_record_length

Since: 1.0

◆ tiepie_hw_oscilloscope_set_record_length()

TIEPIE_HW_API uint64_t tiepie_hw_oscilloscope_set_record_length	(	tiepie_hw_handle	handle,
		uint64_t	record_length
	)

Set the record length of a specified oscilloscope.

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	record_length	The required record length in samples.

Returns: The actually set record length in samples, or 0 when unsuccessful.

Remarks: Changing the record length may affect the segment count.

Status values

TIEPIE_HW_STATUS_VALUE_CLIPPED	The requested record length is outside the valid range and clipped to the closest limit.
TIEPIE_HW_STATUS_VALUE_MODIFIED	The requested record length is within the valid range but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also: tiepie_hw_oscilloscope_get_record_length_max; tiepie_hw_oscilloscope_get_record_length

Since: 1.0