LibTiePie  0.4.3
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Groups Pages
Functions
Status
Measurements

This section contains measurement status related functions. More...

Functions

bool8_t ScpIsRunning (TpDeviceHandle_t hDevice)
 Check whether the instrument is currently measuring.
 
bool8_t ScpIsTriggered (TpDeviceHandle_t hDevice)
 Check whether the instrument has triggered.
 
bool8_t ScpIsDataReady (TpDeviceHandle_t hDevice)
 Check whether new, unread measured data is available.
 
bool8_t ScpIsDataOverflow (TpDeviceHandle_t hDevice)
 Check whether a data overflow has occurred.
 

Detailed Description

This section contains measurement status related functions.

Function Documentation

bool8_t ScpIsRunning ( TpDeviceHandle_t  hDevice)

Check whether the instrument is currently measuring.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if instrument is measuring, BOOL8_FALSE otherwise.
bool8_t ScpIsTriggered ( TpDeviceHandle_t  hDevice)

Check whether the instrument has triggered.

Once a measurement is ready, the triggered status can be checked to determine whether the instrument was triggered.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if oscilloscope has triggered, BOOL8_FALSE otherwise.
bool8_t ScpIsDataReady ( TpDeviceHandle_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 blocks of data are available.

The status is cleared by getting the data, using one of the ScpGetData* routines. If more than one block of unread data is available, multiple calls to ScpGetData* are required to clear the status.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if new measured data is available, BOOL8_FALSE otherwise.
bool8_t ScpIsDataOverflow ( TpDeviceHandle_t  hDevice)

Check whether a data overflow has occurred.

During measuring in streaming mode, new blocks of measured data will become available. When these blocks are not read fast enough, the number of available blocks will increase. When the available buffer space for these blocks is full, the streaming measurement will be aborted and the data overflow status will be set. The blocks of data that were already buffered, remain available to be read.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if overflow occurred, BOOL8_FALSE otherwise.