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 frequency : The frequency property sets the sample frequency 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 frequency.

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

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

Functions
uint32_t	GenGetFrequencyModes (LibTiePieHandle_t hDevice)
	Get the supported generator frequency modes of a specified generator. More...

uint32_t	GenGetFrequencyMode (LibTiePieHandle_t hDevice)
	Get the current generator frequency mode of a specified generator. More...

uint32_t	GenSetFrequencyMode (LibTiePieHandle_t hDevice, uint32_t dwFrequencyMode)
	Set the generator frequency mode of a specified generator. More...

Function Documentation

uint32_t GenGetFrequencyModes ( LibTiePieHandle_t hDevice )

Get the supported generator frequency modes of a specified generator.

Parameters

[in] hDevice A device handle identifying the generator.

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

Status values

NOT_SUPPORTED	The generator does not support frequency mode.
INVALID_HANDLE	The handle is not a valid generator handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetFrequencyMode; GenSetFrequencyMode

Since: 0.4.1

uint32_t GenGetFrequencyMode ( LibTiePieHandle_t hDevice )

Get the current generator frequency mode of a specified generator.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The currently set generator frequency mode, a FM_* value, FM_UNKNOWN when unsuccessful.

Status values

NOT_SUPPORTED	The generator does not support frequency mode.
INVALID_HANDLE	The handle is not a valid generator handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: GenGetFrequencyModes; GenSetFrequencyMode

Since: 0.4.1

uint32_t GenSetFrequencyMode	(	LibTiePieHandle_t	hDevice,
		uint32_t	dwFrequencyMode
	)

Set the generator frequency mode of a specified generator.

Parameters

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

Returns: The actually set generator frequency mode, a FM_* value, FM_UNKNOWN when unsuccessful.

Status values

INVALID_VALUE	The requested frequency mode is invalid.
NOT_SUPPORTED	The generator does not support generator mode.
NOT_CONTROLLABLE	The generator is currently not controllable, see GenIsControllable.
INVALID_HANDLE	The handle is not a valid generator handle.
OBJECT_GONE	The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

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: GenGetFrequencyModes; GenGetFrequencyMode

Since: 0.4.1