libtiepie-hw  1.1.3

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

Collaboration diagram for Frequency:

Functions

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_has_frequency (tiepie_hw_handle handle, uint16_t ch)
 Check whether the currently selected demo signal type supports setting the frequency. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_get_frequency (tiepie_hw_handle handle, uint16_t ch)
 Get the currently selected demo signal frequency of a specified demo oscilloscope channel. More...
 
TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_set_frequency (tiepie_hw_handle handle, uint16_t ch, double value)
 Set the demo signal frequency of a specified demo oscilloscope channel, in Hz. More...
 

Detailed Description

Functions to control the frequency of a demo signal.

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

Function Documentation

◆ tiepie_hw_oscilloscope_channel_demo_has_frequency()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_has_frequency ( tiepie_hw_handle  handle,
uint16_t  ch 
)

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

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 frequency 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_frequency
tiepie_hw_oscilloscope_channel_demo_set_frequency
Since
1.0

◆ tiepie_hw_oscilloscope_channel_demo_get_frequency()

TIEPIE_HW_API double tiepie_hw_oscilloscope_channel_demo_get_frequency ( tiepie_hw_handle  handle,
uint16_t  ch 
)

Get the currently selected demo signal frequency 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 frequency, in Hz.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The currently selected demo signal type does not support getting the demo signal frequency.
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_frequency
tiepie_hw_oscilloscope_channel_demo_set_frequency
Since
1.0

◆ tiepie_hw_oscilloscope_channel_demo_set_frequency()

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

Set the demo signal frequency of a specified demo oscilloscope channel, in Hz.

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 frequency, in Hz.
Returns
The actually set frequency, in Hz.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The currently selected demo signal type does not support setting the demo signal frequency.
TIEPIE_HW_STATUS_INVALID_VALUE The requested signal frequency 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_frequency
tiepie_hw_oscilloscope_channel_demo_get_frequency
Since
1.0