libtiepie-hw  1.1.3
Demo signals

Functions to control demo signals of a demo oscilloscope channel. More...

Collaboration diagram for Demo signals:

Modules

 Amplitude
 Functions to control the amplitude of a demo signal.
 
 Frequency
 Functions to control the frequency of a demo signal.
 
 Offset
 Functions to control the offset of a demo signal.
 
 Symmetry
 Functions to control the symmetry of a demo signal.
 
 Phase
 Functions for controlling the phase of a demo signal.
 
 NoiseEnabled
 Functions for controlling the optional noise of a demo signal.
 

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_demo (tiepie_hw_handle handle)
 Check whether the specified oscilloscope is a demo oscilloscope. More...
 
TIEPIE_HW_API tiepie_hw_demosignal tiepie_hw_oscilloscope_channel_demo_get_signal (tiepie_hw_handle handle, uint16_t ch)
 Get the currently selected demo signal type of a specified demo oscilloscope channel. More...
 
TIEPIE_HW_API tiepie_hw_demosignal tiepie_hw_oscilloscope_channel_demo_set_signal (tiepie_hw_handle handle, uint16_t ch, tiepie_hw_demosignal value)
 Set the demo signal type of a specified demo oscilloscope channel. More...
 

Detailed Description

Functions to control demo signals of a demo oscilloscope channel.

A demo oscilloscope functions identical to a real instrument but it has the additional capability of simulating several different types of signals. Many aspects of these signals can be adjusted.

Function Documentation

◆ tiepie_hw_oscilloscope_is_demo()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_is_demo ( tiepie_hw_handle  handle)

Check whether the specified oscilloscope is a demo oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
TIEPIE_HW_BOOL_TRUE if the specified oscilloscope is a demo oscilloscope, TIEPIE_HW_BOOL_FALSE if not.
See also
tiepie_hw_devicelist_create_demo_device
Status values
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_channel_demo_get_signal()

TIEPIE_HW_API tiepie_hw_demosignal tiepie_hw_oscilloscope_channel_demo_get_signal ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the currently selected demo signal type 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 selected signal type, tiepie_hw_demosignal value.
See also
tiepie_hw_oscilloscope_channel_demo_set_signal
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support getting the demo signal type.
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_set_signal
Since
1.0

◆ tiepie_hw_oscilloscope_channel_demo_set_signal()

TIEPIE_HW_API tiepie_hw_demosignal tiepie_hw_oscilloscope_channel_demo_set_signal ( tiepie_hw_handle  handle,
uint16_t  ch,
tiepie_hw_demosignal  value 
)

Set the demo signal type 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 type, a tiepie_hw_demosignal value.
Returns
The actually set demo signal type, a tiepie_hw_demosignal value.
See also
tiepie_hw_oscilloscope_channel_demo_get_signal
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The indicated channel does not support setting the demo signal type.
TIEPIE_HW_STATUS_INVALID_VALUE The requested signal type 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_demosignal
Since
1.0