Description

Functions to check the measurement status.

These are all functions to poll the measurement status. For some statuses also notifications are available.

Functions
bool8_t	ScpIsRunning (LibTiePieHandle_t hDevice)
	Check whether the oscilloscope is currently measuring. More...

bool8_t	ScpIsTriggered (LibTiePieHandle_t hDevice)
	Check whether the oscilloscope has triggered. More...

bool8_t	ScpIsTimeOutTriggered (LibTiePieHandle_t hDevice)
	Check whether the trigger was caused by the trigger time out. More...

bool8_t	ScpIsForceTriggered (LibTiePieHandle_t hDevice)
	Check whether the trigger was caused by ScpForceTrigger. More...

bool8_t	ScpIsDataReady (LibTiePieHandle_t hDevice)
	Check whether new, unread measured data is available. More...

bool8_t	ScpIsDataOverflow (LibTiePieHandle_t hDevice)
	Check whether a data overflow has occurred. More...

Function Documentation

bool8_t ScpIsRunning ( LibTiePieHandle_t hDevice )

Check whether the oscilloscope is currently measuring.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if oscilloscope is measuring, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since: 0.4.0

bool8_t ScpIsTriggered ( LibTiePieHandle_t hDevice )

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] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if oscilloscope has triggered, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpIsTimeOutTriggered; ScpIsForceTriggered; ScpChTrIsTriggered; ScpTrInIsTriggered

Since: 0.4.0

bool8_t ScpIsTimeOutTriggered ( LibTiePieHandle_t hDevice )

Check whether the trigger was caused by the trigger time out.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if the trigger was caused by the trigger time out, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpIsTriggered; ScpIsForceTriggered; ScpChTrIsTriggered; ScpTrInIsTriggered

Since: 0.5

bool8_t ScpIsForceTriggered ( LibTiePieHandle_t hDevice )

Check whether the trigger was caused by ScpForceTrigger.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if the trigger was caused by ScpForceTrigger, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpIsTriggered; ScpIsTimeOutTriggered; ScpChTrIsTriggered; ScpTrInIsTriggered

Since: 0.5

bool8_t ScpIsDataReady ( LibTiePieHandle_t hDevice )

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 ScpGetData* routines. If more than one chunk of unread data is available, multiple calls to ScpGetData* are required to clear the status.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if new measured data is available, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: notification Data ready

Since: 0.4.0

bool8_t ScpIsDataOverflow ( LibTiePieHandle_t hDevice )

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] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if overflow occurred, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: notification Data overflow

Since: 0.4.0