Description

Functions for controlling the offset of a generator.

The offset of a generator can be set between a minimum and a maximum value. Use GenGetOffsetMin() and GenGetOffsetMax() to get the offset limits.

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

When the generator ouput is switched on but signal generation is stopped, the generator output will be at the currently set offset level.

By default the offset is set to: 0 V.

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

double	GenGetOffsetMin (LibTiePieHandle_t hDevice)
	Get the minimum offset for the current signal type, of a specified generator. More...

double	GenGetOffsetMax (LibTiePieHandle_t hDevice)
	Get the maximum offset for the current signal type, of a specified generator. More...

double	GenGetOffset (LibTiePieHandle_t hDevice)
	Get the current signal offset of a specified generator. More...

double	GenSetOffset (LibTiePieHandle_t hDevice, double dOffset)
	Set the signal offset of a specified generator. More...

Function Documentation

bool8_t GenHasOffset ( LibTiePieHandle_t hDevice )

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

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: GenGetOffsetMin; GenGetOffsetMax; GenGetOffset; GenSetOffset

Since: 0.6

double GenGetOffsetMin ( LibTiePieHandle_t hDevice )

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

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The minimum signal offset in Volt.

Status values

NOT_SUPPORTED	The requested signal type does not support signal offset.
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: GenGetOffsetMax; GenGetOffset; GenSetOffset

Since: 0.4.0

double GenGetOffsetMax ( LibTiePieHandle_t hDevice )

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

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The maximum signal offset in Volt.

Status values

NOT_SUPPORTED	The requested signal type does not support signal offset.
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: GenGetOffsetMin; GenGetOffset; GenSetOffset

Since: 0.4.0

double GenGetOffset ( LibTiePieHandle_t hDevice )

Get the current signal offset of a specified generator.

Parameters

[in] hDevice A device handle identifying the generator.

Returns: The currently set signal offset in Volt.

Status values

NOT_SUPPORTED	The requested signal type does not support signal offset.
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: GenGetOffsetMin; GenGetOffsetMax; GenSetOffset

Since: 0.4.0

double GenSetOffset	(	LibTiePieHandle_t	hDevice,
		double	dOffset
	)

Set the signal offset of a specified generator.

Parameters

[in]	hDevice	A device handle identifying the generator.
[in]	dOffset	The requested signal offset in Volt.

Returns: The actually set signal offset in Volt.

Status values

VALUE_CLIPPED	The requested offset is outside the valid range and clipped to the closest limit.
VALUE_MODIFIED	The requested offset is within the valid range but not available. The closest valid value is set.
NOT_SUPPORTED	The current signal type does not support signal offset.
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.

See also: GenGetOffsetMin; GenGetOffsetMax; GenGetOffset

Since: 0.4.0