Functions for controlling the optional noise of a demo signal. More...

Collaboration diagram for NoiseEnabled:

Functions
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_oscilloscope_channel_demo_has_noise_enabled (tiepie_hw_handle handle, uint16_t ch)
	Check whether the selected demo signal type supports injecting small noise.

TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_oscilloscope_channel_demo_get_noise_enabled (tiepie_hw_handle handle, uint16_t ch)
	Get the currently selected noise injection state of a specified demo oscilloscope channel.

TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_oscilloscope_channel_demo_set_noise_enabled (tiepie_hw_handle handle, uint16_t ch, tiepie_hw_bool value)
	Set the noise injection state of a specified demo oscilloscope channel.

Detailed Description

Functions for controlling the optional noise of a demo signal.

Several of the demo signal types support injecting small noise in the base signal, but others don't. Use tiepie_hw_oscilloscope_channel_demo_has_noise_enabled() to find out whether the selected demo signal type supports injecting small noise.

Function Documentation

◆ tiepie_hw_oscilloscope_channel_demo_has_noise_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_has_noise_enabled	(	tiepie_hw_handle	handle,
		uint16_t	ch
	)

Check whether the selected demo signal type supports injecting small noise.

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.

Returns: TIEPIE_HW_BOOL_TRUE if injecting small noise 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_noise_enabled; tiepie_hw_oscilloscope_channel_demo_set_noise_enabled

Since: 1.0

◆ tiepie_hw_oscilloscope_channel_demo_get_noise_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_get_noise_enabled	(	tiepie_hw_handle	handle,
		uint16_t	ch
	)

Get the currently selected noise injection state of a specified demo oscilloscope channel.

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.

Returns: TIEPIE_HW_BOOL_TRUE if injecting small noise is enabled, TIEPIE_HW_BOOL_FALSE if not.

Status values

TIEPIE_HW_STATUS_NOT_SUPPORTED	The currently selected demo signal type does not support noise injection.
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_noise_enabled; tiepie_hw_oscilloscope_channel_demo_set_noise_enabled

Since: 1.0

◆ tiepie_hw_oscilloscope_channel_demo_set_noise_enabled()

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_demo_set_noise_enabled	(	tiepie_hw_handle	handle,
		uint16_t	ch,
		tiepie_hw_bool	value
	)

Set the noise injection state of a specified demo oscilloscope channel.

Parameters

[in]	handle	A device handle identifying the oscilloscope.
[in]	ch	The channel number identifying the channel, `0` to `tiepie_hw_oscilloscope_get_channel_count() - 1`.
[in]	value	TIEPIE_HW_BOOL_TRUE to enable noise injection, TIEPIE_HW_BOOL_FALSE to disable noise injection

Returns: The currently selected noise injection state, TIEPIE_HW_BOOL_TRUE if enabled, flase is disabled

Status values

TIEPIE_HW_STATUS_NOT_SUPPORTED	The currently selected demo signal type does not support noise injection.
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_noise_enabled; tiepie_hw_oscilloscope_channel_demo_get_noise_enabled

Since: 1.0