libtiepie-hw  1.2.0
Segment count

Functions to control the segment count. More...

Collaboration diagram for Segment count:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_segment_count_max (tiepie_hw_handle handle)
 Get the maximum supported number of segments of a specified oscilloscope. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_segment_count (tiepie_hw_handle handle)
 Get the currently selected number of segments of a specified oscilloscope. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_set_segment_count (tiepie_hw_handle handle, uint32_t value)
 Set the number of segments of a specified oscilloscope. More...
 

Detailed Description

Functions to control the segment count.

The segment count can be affected by changing the record length.

Function Documentation

◆ tiepie_hw_oscilloscope_get_segment_count_max()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_segment_count_max ( tiepie_hw_handle  handle)

Get the maximum supported number of segments of a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The maximum supported number of segments, or 0 when unsuccessful.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED Segment count is not supported by the hardware.
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_segment_count
tiepie_hw_oscilloscope_set_segment_count
Since
1.0

◆ tiepie_hw_oscilloscope_get_segment_count()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_segment_count ( tiepie_hw_handle  handle)

Get the currently selected number of segments of a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The currently selected number of segments, or 0 when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_NOT_SUPPORTED Segment count is not supported by the hardware.
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_segment_count_max
tiepie_hw_oscilloscope_set_segment_count
Since
1.0

◆ tiepie_hw_oscilloscope_set_segment_count()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_set_segment_count ( tiepie_hw_handle  handle,
uint32_t  value 
)

Set the number of segments of a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]valueThe required number of segments.
Returns
The actually set number of segments, or 0 when unsuccessful.
Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested segment count is outside the valid range and clipped to the closest limit.
TIEPIE_HW_STATUS_VALUE_MODIFIED The requested segment count is within the valid range but not available. The closest valid value is set.
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_NOT_SUPPORTED Segment count is not supported by the hardware.
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_segment_count_max
tiepie_hw_oscilloscope_get_segment_count
Since
1.0