Functions to control the enabled state of an oscilloscope channel. More...

Collaboration diagram for Enabled:

Functions
TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_oscilloscope_channel_get_enabled (tiepie_hw_handle handle, uint16_t ch)
	Check whether a specified channel is currently enabled.

TIEPIE_HW_API tiepie_hw_bool	tiepie_hw_oscilloscope_channel_set_enabled (tiepie_hw_handle handle, uint16_t ch, tiepie_hw_bool value)
	Set channel enable.

Detailed Description

Functions to control the enabled state of an oscilloscope channel.

The enabled state of a channel determines whether the channel is measured.

By default all channels are enabled.

Function Documentation

TIEPIE_HW_API tiepie_hw_bool tiepie_hw_oscilloscope_channel_get_enabled	(	tiepie_hw_handle	handle,
		uint16_t	ch
	)

Check whether a specified channel is currently enabled.

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`.

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

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

Set channel enable.

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 or TIEPIE_HW_BOOL_FALSE.

Status values

TIEPIE_HW_STATUS_NOT_AVAILABLE
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

Remarks: Changing the channel enable may affect the sample rate, record length and/or channel trigger enabled.