LibTiePie  0.9.16
Library for interfacing TiePie engineering instruments
Signal type

Description

Functions for controlling the signal type of a generator.

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

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

Functions

uint32_t GenGetSignalTypes (LibTiePieHandle_t hDevice)
 Get the supported signal types of a specified generator. More...
 
uint32_t GenGetSignalType (LibTiePieHandle_t hDevice)
 Get the currently selected signal type of a specified generator. More...
 
uint32_t GenSetSignalType (LibTiePieHandle_t hDevice, uint32_t dwSignalType)
 Set the signal type of a specified generator. More...
 

Function Documentation

uint32_t GenGetSignalTypes ( LibTiePieHandle_t  hDevice)

Get the supported signal types of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The supported signal types, a set of ST_* values, STM_NONE when unsuccessful.
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_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenGetSignalType
GenSetSignalType
Since
0.4.0
uint32_t GenGetSignalType ( LibTiePieHandle_t  hDevice)

Get the currently selected signal type of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The currently set signal type, a ST_* value, ST_UNKNOWN when unsuccessful.
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_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
See also
GenGetSignalTypes
GenSetSignalType
Since
0.4.0
uint32_t GenSetSignalType ( LibTiePieHandle_t  hDevice,
uint32_t  dwSignalType 
)

Set the signal type of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
[in]dwSignalTypeThe requested signal type, a ST_* value.
Returns
The actually set signal type, a ST_* value, ST_UNKNOWN when unsuccessful.
Status values
INVALID_VALUE The requested signal type is invalid.
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_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
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
GenGetSignalTypes
GenGetSignalType
Since
0.4.0