Functions to check the measurement status. More...
Functions | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_running (tiepie_hw_handle handle) |
| Check whether the oscilloscope is currently measuring. More... | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_triggered (tiepie_hw_handle handle) |
| Check whether the oscilloscope has triggered. More... | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_timeout_triggered (tiepie_hw_handle handle) |
| Check whether the trigger was caused by the trigger time out. More... | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_force_triggered (tiepie_hw_handle handle) |
| Check whether the trigger was caused by tiepie_hw_oscilloscope_force_trigger. More... | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_data_ready (tiepie_hw_handle handle) |
| Check whether new, unread measured data is available. More... | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_oscilloscope_is_data_overflow (tiepie_hw_handle handle) |
| Check whether a data overflow has occurred. More... | |
Detailed Description
Functions to check the measurement status.
These are all functions to poll the measurement status. For some statuses also callbacks are available.
Function Documentation
◆ tiepie_hw_oscilloscope_is_running()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_running | ( | tiepie_hw_handle | handle | ) |
Check whether the oscilloscope is currently measuring.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if oscilloscope is measuring, 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_is_triggered()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_triggered | ( | tiepie_hw_handle | handle | ) |
Check whether the oscilloscope has triggered.
Once a measurement is ready, the triggered status can be checked to determine whether the oscilloscope was triggered.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if oscilloscope has triggered, 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
- See also
- tiepie_hw_oscilloscope_is_timeout_triggered
- tiepie_hw_oscilloscope_is_force_triggered
- tiepie_hw_oscilloscope_channel_trigger_is_triggered
- tiepie_hw_oscilloscope_trigger_input_is_triggered
- Since
- 1.0
◆ tiepie_hw_oscilloscope_is_timeout_triggered()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_timeout_triggered | ( | tiepie_hw_handle | handle | ) |
Check whether the trigger was caused by the trigger time out.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if the trigger was caused by the trigger time out, 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
- See also
- tiepie_hw_oscilloscope_is_triggered
- tiepie_hw_oscilloscope_is_force_triggered
- tiepie_hw_oscilloscope_channel_trigger_is_triggered
- tiepie_hw_oscilloscope_trigger_input_is_triggered
- Since
- 1.0
◆ tiepie_hw_oscilloscope_is_force_triggered()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_force_triggered | ( | tiepie_hw_handle | handle | ) |
Check whether the trigger was caused by tiepie_hw_oscilloscope_force_trigger.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if the trigger was caused by tiepie_hw_oscilloscope_force_trigger, 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
- See also
- tiepie_hw_oscilloscope_is_triggered
- tiepie_hw_oscilloscope_is_timeout_triggered
- tiepie_hw_oscilloscope_channel_trigger_is_triggered
- tiepie_hw_oscilloscope_trigger_input_is_triggered
- Since
- 1.0
◆ tiepie_hw_oscilloscope_is_data_ready()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_data_ready | ( | tiepie_hw_handle | handle | ) |
Check whether new, unread measured data is available.
When measuring in block mode, the data ready status is set when the measurement is ready and the measured data is available.
When measuring in streaming mode, the data ready status is set when one or more new chunks of data are available.
The status is cleared by getting the data, using one of the Scp_get_data* routines. If more than one chunk of unread data is available, multiple calls to tiepie_hw_oscilloscope_get_data* are required to clear the status.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if new measured data is available, 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
- See also
- notification scp_callbacks_data_ready
- Since
- 1.0
◆ tiepie_hw_oscilloscope_is_data_overflow()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_data_overflow | ( | tiepie_hw_handle | handle | ) |
Check whether a data overflow has occurred.
During measuring in streaming mode, new chunks of measured data will become available. When these chunks are not read fast enough, the number of available chunks will increase. When the available buffer space for these chunks is full, the streaming measurement will be aborted and the data overflow status will be set. The chunks of data that were already buffered, remain available to be read.
- Parameters
-
[in] handle A device handle identifying the oscilloscope.
- Returns
- TIEPIE_HW_BOOL_TRUE if overflow occurred, 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
- See also
- notification scp_callbacks_data_overflow
- Since
- 1.0
