Functions to control the generator frequency mode. More...

Collaboration diagram for Frequency mode:

Functions
TIEPIE_HW_API uint32_t	tiepie_hw_generator_get_frequency_modes (tiepie_hw_handle handle)
	Get the supported generator frequency modes of a specified generator.

TIEPIE_HW_API uint32_t	tiepie_hw_generator_get_frequency_mode (tiepie_hw_handle handle)
	Get the current generator frequency mode of a specified generator.

TIEPIE_HW_API uint32_t	tiepie_hw_generator_set_frequency_mode (tiepie_hw_handle handle, uint32_t value)
	Set the generator frequency mode of a specified generator.

Detailed Description

Functions to control the generator frequency mode.

When signal type arbitrary is selected, the frequency mode of the Arbitrary waveform generator can be set. The following frequency modes are supported:

Signal frequency : the frequency property sets the signal frequency, the frequency at which the selected signal will be repeated.
Sample rate : The frequency property sets the sample rate at which the individual samples of the selected signal will be generated.

With signal types sine, triangle, square and DC, the frequency mode is fixed to signal frequency. With signal type noise the frequency mode is fixed to sample rate.

The frequency mode can be affected by changing the signal type.

By default the frequency mode is set to signal frequency (TIEPIE_HW_FM_SIGNALFREQUENCY)

Function Documentation

◆ tiepie_hw_generator_get_frequency_modes()

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_frequency_modes ( tiepie_hw_handle handle )

Get the supported generator frequency modes of a specified generator.

Parameters

[in] handle A device handle identifying the generator.

Returns: The supported generator frequency modes, a set of OR-ed TIEPIE_HW_FM_* values, or TIEPIE_HW_FMM_NONE.

Status values

TIEPIE_HW_STATUS_NOT_SUPPORTED	The generator does not support frequency mode.
TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also: tiepie_hw_generator_get_frequency_mode; tiepie_hw_generator_set_frequency_mode

Since: 1.0

◆ tiepie_hw_generator_get_frequency_mode()

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_frequency_mode ( tiepie_hw_handle handle )

Get the current generator frequency mode of a specified generator.

Parameters

[in] handle A device handle identifying the generator.

Returns: The currently set generator frequency mode, a TIEPIE_HW_FM_* value, TIEPIE_HW_FM_UNKNOWN when unsuccessful.

Status values

TIEPIE_HW_STATUS_NOT_SUPPORTED	The generator does not support frequency mode.
TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

See also: tiepie_hw_generator_get_frequency_modes; tiepie_hw_generator_set_frequency_mode

Since: 1.0

◆ tiepie_hw_generator_set_frequency_mode()

TIEPIE_HW_API uint32_t tiepie_hw_generator_set_frequency_mode	(	tiepie_hw_handle	handle,
		uint32_t	value
	)

Set the generator frequency mode of a specified generator.

Parameters

[in]	handle	A device handle identifying the generator.
[in]	value	The requested generator frequency mode, a TIEPIE_HW_FM_* value.

Returns: The actually set generator frequency mode, a TIEPIE_HW_FM_* value, TIEPIE_HW_FM_UNKNOWN when unsuccessful.

Status values

TIEPIE_HW_STATUS_INVALID_VALUE	The requested frequency mode is invalid.
TIEPIE_HW_STATUS_NOT_SUPPORTED	The generator does not support generator mode.
TIEPIE_HW_STATUS_NOT_CONTROLLABLE
TIEPIE_HW_STATUS_INVALID_HANDLE	The handle is not a valid generator handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS

Remarks: Setting frequency mode is only available when signal type Arbitrary is active.; When signal type Sine, Triangle or Square is active, frequency mode is fixed at signal frequency.; When signal type Noise is active, frequency mode is fixed at sample frequency.; Changing the frequency mode can affect the generator mode.

See also: tiepie_hw_generator_get_frequency_modes; tiepie_hw_generator_get_frequency_mode

Since: 1.0