LibTiePie  0.9.14
Library for interfacing TiePie engineering instruments

Description

Functions that provide information of a generator.

Functions

uint32_t GenGetConnectorType (LibTiePieHandle_t hDevice)
 Get the output connector type for a specified generator. More...
 
bool8_t GenIsDifferential (LibTiePieHandle_t hDevice)
 Check whether the output of a specified generator is differential. More...
 
double GenGetImpedance (LibTiePieHandle_t hDevice)
 Get the output impedance of a specified generator. More...
 
uint8_t GenGetResolution (LibTiePieHandle_t hDevice)
 Get the DAC resolution of a specified generator. More...
 
double GenGetOutputValueMin (LibTiePieHandle_t hDevice)
 Get the minimum output value of a specified generator. More...
 
double GenGetOutputValueMax (LibTiePieHandle_t hDevice)
 Get the maximum output value of a specified generator. More...
 

Function Documentation

uint32_t GenGetConnectorType ( LibTiePieHandle_t  hDevice)

Get the output connector type for a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The output connector type, CONNECTORTYPE_UNKNOWN when unsuccessful.
Status values
NOT_SUPPORTED The generator does not support getting the connector type.
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.
Since
0.4.0
bool8_t GenIsDifferential ( LibTiePieHandle_t  hDevice)

Check whether the output of a specified generator is differential.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
BOOL8_TRUE when the output is differential, BOOL8_FALSE otherwise.
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.
Since
0.4.0
double GenGetImpedance ( LibTiePieHandle_t  hDevice)

Get the output impedance of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The output impedance in Ohm.
Status values
NOT_SUPPORTED The generator does not support getting the output impedance.
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.
Since
0.4.0
uint8_t GenGetResolution ( LibTiePieHandle_t  hDevice)

Get the DAC resolution of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The resolution in bits.
Status values
NOT_SUPPORTED The generator does not support getting the resolution.
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.
Since
0.4.1
double GenGetOutputValueMin ( LibTiePieHandle_t  hDevice)

Get the minimum output value of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The minimum output value in Volt.
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
GenGetOutputValueMax
Since
0.4.5
double GenGetOutputValueMax ( LibTiePieHandle_t  hDevice)

Get the maximum output value of a specified generator.

Parameters
[in]hDeviceA device handle identifying the generator.
Returns
The maximum output value in Volt.
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
GenGetOutputValueMin
Since
0.4.5