libtiepie-hw  1.1.6
Measurements

Functions to perform measurements. More...

Collaboration diagram for Measurements:

Modules

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

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_start (tiepie_hw_handle handle)
 Start a single measurement. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_stop (tiepie_hw_handle handle)
 Stop a running measurement. More...
 
TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_force_trigger (tiepie_hw_handle handle)
 Force a trigger. More...
 

Detailed 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 callbacks are available to determine the measurement status.

Function Documentation

◆ tiepie_hw_oscilloscope_start()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_start ( tiepie_hw_handle  handle)

Start a single measurement.

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

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if the measurement is started, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_UNSUCCESSFUL The measurement could not be started.
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_MEASUREMENT_RUNNING
TIEPIE_HW_STATUS_SUCCESS
Since
1.0

◆ tiepie_hw_oscilloscope_stop()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_stop ( tiepie_hw_handle  handle)

Stop a running measurement.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if the measurement is aborted, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_UNSUCCESSFUL The measurement could not be stopped.
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_force_trigger()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_force_trigger ( tiepie_hw_handle  handle)

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]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if succeeded, TIEPIE_HW_BOOL_FALSE otherwise.
Status values
TIEPIE_HW_STATUS_UNSUCCESSFUL The trigger could not be forced.
TIEPIE_HW_STATUS_NOT_SUPPORTED The oscilloscope does not support force trigger.
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
Returns
TIEPIE_HW_BOOL_TRUE if succeeded, TIEPIE_HW_BOOL_FALSE otherwise.
Since
1.0