Functions for controlling the signal type of a generator. More...

Collaboration diagram for Signal type:

Functions
TIEPIE_HW_API uint32_t	tiepie_hw_generator_get_signal_types (tiepie_hw_handle handle)
	Get the supported signal types of a specified generator.

TIEPIE_HW_API uint32_t	tiepie_hw_generator_get_signal_type (tiepie_hw_handle handle)
	Get the currently selected signal type of a specified generator.

TIEPIE_HW_API uint32_t	tiepie_hw_generator_set_signal_type (tiepie_hw_handle handle, uint32_t value)
	Set the signal type of a specified generator.

Detailed Description

Functions for controlling the signal type of a generator.

The generator supports several standard signal types. Use tiepie_hw_generator_get_signal_types() to find the supported signal types.

By default signal type is set to: Sine (TIEPIE_HW_ST_SINE).

Function Documentation

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_signal_types ( tiepie_hw_handle handle )

Get the supported signal types of a specified generator.

Parameters

[in] handle A device handle identifying the generator.

Returns: The supported signal types, a set of TIEPIE_HW_ST_* values, TIEPIE_HW_STM_NONE when unsuccessful.

Status values

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_signal_type; tiepie_hw_generator_set_signal_type

TIEPIE_HW_API uint32_t tiepie_hw_generator_get_signal_type ( tiepie_hw_handle handle )

Get the currently selected signal type of a specified generator.

Parameters

[in] handle A device handle identifying the generator.

Returns: The currently set signal type, a TIEPIE_HW_ST_* value, TIEPIE_HW_ST_UNKNOWN when unsuccessful.

Status values

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_signal_types; tiepie_hw_generator_set_signal_type

TIEPIE_HW_API uint32_t tiepie_hw_generator_set_signal_type	(	tiepie_hw_handle	handle,
		uint32_t	value
	)

Set the signal type of a specified generator.

Parameters

[in]	handle	A device handle identifying the generator.
[in]	value	The requested signal type, a TIEPIE_HW_ST_* value.

Returns: The actually set signal type, a TIEPIE_HW_ST_* value, TIEPIE_HW_ST_UNKNOWN when unsuccessful.

Status values

TIEPIE_HW_STATUS_INVALID_VALUE	The requested signal type is invalid.
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: When the generator is active, changing the signal type may shortly interrupt the output signal.; Changing the signal type can affect the frequency mode, generator mode and/or offset.; Setting certain signal types will make other generator properties unavailable.

See also: tiepie_hw_generator_get_signal_types; tiepie_hw_generator_get_signal_type