LibTiePie  0.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages
Measurements

Description

Functions to perform measurements.

Oscilloscopes can measure in block mode or in streaming mode. This is determined by the measure mode.

Several polling routines and notifications are available to determine the measurement status.

Modules

 Mode
 Functions for controlling the measure mode.
 
 Status
 Functions to check the measurement status.
 

Functions

bool8_t ScpStart (TpDeviceHandle_t hDevice)
 Start a single measurement. More...
 
bool8_t ScpStop (TpDeviceHandle_t hDevice)
 Stop a running measurement. More...
 
bool8_t ScpForceTrigger (TpDeviceHandle_t hDevice)
 Force a trigger. More...
 

Function Documentation

bool8_t ScpStart ( TpDeviceHandle_t  hDevice)

Start a single measurement.

Use the measurement status functions or notifications to determine the status of a running measurement.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
BOOL8_TRUE if the measurement is started, BOOL8_FALSE otherwise.
Status values
UNSUCCESSFUL The measurement could not be started.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.4.0
bool8_t ScpStop ( TpDeviceHandle_t  hDevice)

Stop a running measurement.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
BOOL8_TRUE if the measurement is aborted, BOOL8_FALSE otherwise.
Status values
UNSUCCESSFUL The measurement could not be stopped.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.5
bool8_t ScpForceTrigger ( TpDeviceHandle_t  hDevice)

Force a trigger.

If the trigger conditions are set in such a way that the input signal(s) will never meet the trigger settings, the instrument will wait forever. Use this function to force a trigger, independent from the input signal(s).

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
BOOL8_TRUE if succeeded, BOOL8_FALSE otherwise.
Status values
UNSUCCESSFUL The trigger could not be forced.
NOT_SUPPORTED The oscilloscope does not support force trigger.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
DEVICE_GONE The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Returns
BOOL8_TRUE if succeeded, BOOL8_FALSE otherwise.
Since
0.5