libtiepie-hw  1.2.0

Functions to control the amplitude of a demo signal. More...

Collaboration diagram for Amplitude:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_has_amplitude (tiepie_hw_handle handle, uint16_t ch)
 Check whether the currently selected demo signal type supports setting the amplitude. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_get_amplitude (tiepie_hw_handle handle, uint16_t ch)
 Get the currently selected demo signal amplitude of a specified demo oscilloscope channel. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_set_amplitude (tiepie_hw_handle handle, uint16_t ch, double value)
 Set the demo signal amplitude of a specified demo oscilloscope channel. More...
 

Detailed Description

Functions to control the amplitude of a demo signal.

Several of the demo signal types support setting the signal amplitude, but others don't. Use tiepie_hw_oscilloscope_channel_demo_has_amplitude() to find out whether the selected demo signal type supports setting the amplitude.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_demo_has_amplitude()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_has_amplitude ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Check whether the currently selected demo signal type supports setting the amplitude.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
TIEPIE_HW_BOOL_TRUE if setting the amplitude is supported, TIEPIE_HW_BOOL_FALSE if not.
Status values
TIEPIE_HW_STATUS_INVALID_CHANNEL
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_channel_demo_get_amplitude
tiepie_hw_oscilloscope_channel_demo_set_amplitude
Since
1.0

◆ tiepie_hw_oscilloscope_channel_demo_get_amplitude()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_get_amplitude ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the currently selected demo signal amplitude of a specified demo oscilloscope channel.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
Returns
The currently set demo signal amplitude, in Volt.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The currently selected demo signal type does not support getting the demo signal amplitude.
TIEPIE_HW_STATUS_INVALID_CHANNEL
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_channel_demo_has_amplitude
tiepie_hw_oscilloscope_channel_demo_set_amplitude
Since
1.0

◆ tiepie_hw_oscilloscope_channel_demo_set_amplitude()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_set_amplitude ( tiepie_hw_handle  handle,
uint16_t  ch,
double  value 
)

Set the demo signal amplitude of a specified demo oscilloscope channel.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]chThe channel number identifying the channel, 0 to tiepie_hw_oscilloscope_get_channel_count() - 1.
[in]valueThe requested demo signal amplitude, in Volt.
Returns
The actually set amplitude, in Volt.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The currently selected demo signal type does not support setting the demo signal amplitude.
TIEPIE_HW_STATUS_INVALID_VALUE The requested signal amplitude is not valid.
TIEPIE_HW_STATUS_INVALID_CHANNEL
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_channel_demo_has_amplitude
tiepie_hw_oscilloscope_channel_demo_get_amplitude
Since
1.0