libtiepie-hw  1.1.6
Presamples valid

Functions to control the trigger presamples valid of an oscilloscope. More...

Collaboration diagram for Presamples valid:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_has_presamples_valid (tiepie_hw_handle handle)
 Check whether the oscilloscope has presamples valid support with the currently selected measure mode. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_has_presamples_valid_ex (tiepie_hw_handle handle, uint32_t measure_mode)
 Check whether the oscilloscope has presamples valid support for a specific measure mode. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_get_presamples_valid (tiepie_hw_handle handle)
 Get presamples valid for a specified measure mode, for a specified oscilloscope. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_set_presamples_valid (tiepie_hw_handle handle, tiepie_hw_bool value)
 Set presamples valid, for a specified oscilloscope. More...
 

Detailed Description

Functions to control the trigger presamples valid of an oscilloscope.

Function Documentation

◆ tiepie_hw_oscilloscope_has_presamples_valid()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_has_presamples_valid ( tiepie_hw_handle  handle)

Check whether the oscilloscope has presamples valid support with the currently selected measure mode.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if the oscilloscope has presamples valid support, TIEPIE_HW_BOOL_FALSE otherwise.
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
Since
1.0

◆ tiepie_hw_oscilloscope_has_presamples_valid_ex()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_has_presamples_valid_ex ( tiepie_hw_handle  handle,
uint32_t  measure_mode 
)

Check whether the oscilloscope has presamples valid support for a specific measure mode.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]measure_modeMeasure mode, a TIEPIE_HW_MM_* value.
Returns
TIEPIE_HW_BOOL_TRUE if the oscilloscope has presamples valid support, TIEPIE_HW_BOOL_FALSE otherwise.
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
Since
1.0.1

◆ tiepie_hw_oscilloscope_get_presamples_valid()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_get_presamples_valid ( tiepie_hw_handle  handle)

Get presamples valid for a specified measure mode, for a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if presamples valid is enabled, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support presamples valid.
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_has_presamples_valid
tiepie_hw_oscilloscope_set_presamples_valid
Since
1.0

◆ tiepie_hw_oscilloscope_set_presamples_valid()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_set_presamples_valid ( tiepie_hw_handle  handle,
tiepie_hw_bool  value 
)

Set presamples valid, for a specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]valueTIEPIE_HW_BOOL_TRUE to enable presamples valid, TIEPIE_HW_BOOL_FALSE otherwise.
Returns
The actually set value.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support presamples valid.
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_has_presamples_valid
tiepie_hw_oscilloscope_get_presamples_valid
Since
1.0