Description

Functions for controlling the amplitude and amplitude range of a generator.

The amplitude of a generator can be set between a minimum and a maximum value. Use GenGetAmplitudeMin() and GenGetAmplitudeMax() to get the amplitude limits.

Amplitude and Offset combined cannot exceed the minimum and maximum output value of the generator. Setting a larger amplitude will clip the amplitude to a valid value.

A generator has one or more output ranges, use GenSetAmplitudeRange() to set the required range or GenSetAmplitudeAutoRanging to enable amplitude auto ranging.

By default the amplitude is set to: 1 V and auto ranging is enabled (BOOL8_TRUE).

When signal type DC is active, amplitude is not available. Use GenHasAmplitude() to check whether amplitude is available for the currently set signal type.

Modules
	Amplitude range
	Functions for controlling the amplitude range of a generator.

Functions
bool8_t	GenHasAmplitude (LibTiePieHandle_t hDevice)
	Check whether the current signal type of a specified generator supports controlling the signal amplitude. More...

double	GenGetAmplitudeMin (LibTiePieHandle_t hDevice)
	Get the minimum signal amplitude for the current signal type of a specified generator. More...

double	GenGetAmplitudeMax (LibTiePieHandle_t hDevice)
	Get the maximum signal amplitude for the current signal type of a specified generator. More...

double	GenGetAmplitude (LibTiePieHandle_t hDevice)
	Get the currently set signal amplitude of a specified generator. More...

double	GenSetAmplitude (LibTiePieHandle_t hDevice, double dAmplitude)
	Set the signal amplitude of a specified generator. More...

Function Documentation

bool8_t GenHasAmplitude ( LibTiePieHandle_t hDevice )

Check whether the current signal type of a specified generator supports controlling the signal amplitude.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: BOOL8_TRUE if supported, BOOL8_FALSE if not.

Status values

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: GenGetAmplitudeMin; GenGetAmplitudeMax; GenGetAmplitude; GenSetAmplitude

Since: 0.6

double GenGetAmplitudeMin ( LibTiePieHandle_t hDevice )

Get the minimum signal amplitude for the current signal type of a specified generator.

When amplitude auto ranging is enabled, the minimum value of all amplitude ranges is returned. When amplitude auto ranging is disabled, the minimum value for the currently set amplitude range is returned.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The minimum signal amplitude in Volt.

Status values

NOT_SUPPORTED	The current signal type does not support signal amplitude.
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: GenGetAmplitudeMax; GenGetAmplitude; GenSetAmplitude

Since: 0.4.0

double GenGetAmplitudeMax ( LibTiePieHandle_t hDevice )

Get the maximum signal amplitude for the current signal type of a specified generator.

When amplitude auto ranging is enabled, the maximum value for the highest amplitude range is returned. When amplitude auto ranging is disabled, the maximum value for the currently set amplitude range is returned.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The maximum signal amplitude in Volt.

Status values

NOT_SUPPORTED	The current signal type does not support signal amplitude.
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: GenGetAmplitudeMin; GenGetAmplitude; GenSetAmplitude

Since: 0.4.0

double GenGetAmplitude ( LibTiePieHandle_t hDevice )

Get the currently set signal amplitude of a specified generator.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The currently set signal amplitude in Volt.

Status values

NOT_SUPPORTED	The current signal type does not support signal amplitude.
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: GenGetAmplitudeMin; GenGetAmplitudeMax; GenSetAmplitude

Since: 0.4.0

double GenSetAmplitude	(	LibTiePieHandle_t	hDevice,
		double	dAmplitude
	)

Set the signal amplitude of a specified generator.

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	dAmplitude	The requested signal amplitude.

Returns: The actually set signal amplitude.

Status values

VALUE_CLIPPED	The requested amplitude is outside the valid range and clipped to the closest limit.
VALUE_MODIFIED	The requested amplitude is within the valid range but not available. The closest valid value is set.
INVALID_VALUE	The requested amplitude is < `0`.
NOT_SUPPORTED	The current signal type does not support signal amplitude.
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 the amplitude may change the amplitude range when amplitude auto ranging is enabled.; Setting the amplitude may cause a new waveform pattern to be uploaded when signal type Square wave is active, shortly interrupting the output signal.

See also: GenGetAmplitudeMin; GenGetAmplitudeMax; GenGetAmplitude

Since: 0.4.0

Description

Modules

Functions

Function Documentation