LibTiePie  0.4.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages
Deprecated

Description

This section contains deprecated functions.

They will be removed in LibTiePie 1.0.

Functions

uint32_t GenGetModes (TpDeviceHandle_t hDevice)
 Get supported generator frequency modes. More...
 
uint32_t GenGetMode (TpDeviceHandle_t hDevice)
 Get generator frequency mode. More...
 
uint32_t GenSetMode (TpDeviceHandle_t hDevice, uint32_t dwMode)
 Set generator frequency mode. More...
 
bool8_t GenGetAutoRanging (TpDeviceHandle_t hDevice)
 Get auto ranging. More...
 
bool8_t GenSetAutoRanging (TpDeviceHandle_t hDevice, bool8_t bEnable)
 Set auto ranging. More...
 
uint32_t GenGetRanges (TpDeviceHandle_t hDevice, double *pList, uint32_t dwLength)
 Get supported ranges. More...
 
double GenGetRange (TpDeviceHandle_t hDevice)
 Get range. More...
 
double GenSetRange (TpDeviceHandle_t hDevice, double dRange)
 Set range. More...
 
uint64_t GenGetTriggerSources (TpDeviceHandle_t hDevice)
 Get supported trigger sources. More...
 
uint64_t GenGetTriggerSourceAND (TpDeviceHandle_t hDevice)
 Get trigger sources AND. More...
 
uint64_t GenSetTriggerSourceAND (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask)
 Set trigger sources AND. More...
 
uint64_t GenGetTriggerSourceOR (TpDeviceHandle_t hDevice)
 Get trigger sources OR. More...
 
uint64_t GenSetTriggerSourceOR (TpDeviceHandle_t hDevice, uint64_t qwTriggerSourceMask)
 Set trigger sources OR. More...
 

Function Documentation

uint32_t GenGetModes ( TpDeviceHandle_t  hDevice)

Get supported generator frequency modes.

Deprecated:
Will be removed in version 1.0, use: GenGetFrequencyModes().
Parameters
hDeviceA device handle.
Returns
Supported generator frequency modes, a set of OR-ed FM_* values.
Since
0.4.0
uint32_t GenGetMode ( TpDeviceHandle_t  hDevice)

Get generator frequency mode.

Deprecated:
Will be removed in version 1.0, use: GenGetFrequencyMode().
Parameters
hDeviceA device handle.
Returns
Generator frequency mode, a FM_* value.
Since
0.4.0
uint32_t GenSetMode ( TpDeviceHandle_t  hDevice,
uint32_t  dwMode 
)

Set generator frequency mode.

Deprecated:
Will be removed in version 1.0, use: GenSetFrequencyMode().
Parameters
hDeviceA device handle.
dwModeGenerator frequency mode, a FM_* value.
Returns
Generator frequency mode, a FM_* value.
Since
0.4.0
bool8_t GenGetAutoRanging ( TpDeviceHandle_t  hDevice)

Get auto ranging.

Deprecated:
Will be removed in version 1.0, use: GenGetAmplitudeAutoRanging().
Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
Since
0.4.0
bool8_t GenSetAutoRanging ( TpDeviceHandle_t  hDevice,
bool8_t  bEnable 
)

Set auto ranging.

Deprecated:
Will be removed in version 1.0, use: GenSetAmplitudeAutoRanging().
Parameters
hDeviceA device handle.
bEnableBOOL8_TRUE to enable or BOOL8_FALSE to disable.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
Since
0.4.0
uint32_t GenGetRanges ( TpDeviceHandle_t  hDevice,
double *  pList,
uint32_t  dwLength 
)

Get supported ranges.

Deprecated:
Will be removed in version 1.0, use: GenGetAmplitudeRanges().
Parameters
hDeviceA device handle.
pListPointer to array.
dwLengthNumber of elements in array.
Returns
Total number of ranges.
Since
0.4.0
double GenGetRange ( TpDeviceHandle_t  hDevice)

Get range.

Deprecated:
Will be removed in version 1.0, use: GenGetAmplitudeRange().
Parameters
hDeviceA device handle.
Returns
Range.
Since
0.4.0
double GenSetRange ( TpDeviceHandle_t  hDevice,
double  dRange 
)

Set range.

Deprecated:
Will be removed in version 1.0, use: GenSetAmplitudeRange().
Parameters
hDeviceA device handle.
dRangeMaximum value that must fit within range.
Returns
Range.
Example
double dRange = 10;
dRange = GenSetRange( hDevice , dRange );
printf( "GenSetRange = %f" , dRange );
Since
0.4.0
uint64_t GenGetTriggerSources ( TpDeviceHandle_t  hDevice)

Get supported trigger sources.

Deprecated:
Will be removed in version 1.0, see trigger input(s).
Parameters
hDeviceA device handle.
Returns
Supported trigger sources, a set of OR-ed TS_CH* values.
Since
0.4.0
uint64_t GenGetTriggerSourceAND ( TpDeviceHandle_t  hDevice)

Get trigger sources AND.

Deprecated:
Will be removed in version 1.0, see trigger input(s).
Parameters
hDeviceA device handle.
Returns
Trigger sources, a set of OR-ed TS_CH* values.
Since
0.4.0
uint64_t GenSetTriggerSourceAND ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask 
)

Set trigger sources AND.

Deprecated:
Will be removed in version 1.0, see trigger input(s).
Parameters
hDeviceA device handle.
qwTriggerSourceMaskTrigger sources, a set of OR-ed TS_CH* values.
Returns
Trigger sources, a set of OR-ed TS_CH* values.
Since
0.4.0
uint64_t GenGetTriggerSourceOR ( TpDeviceHandle_t  hDevice)

Get trigger sources OR.

Deprecated:
Will be removed in version 1.0, see trigger input(s).
Parameters
hDeviceA device handle.
Returns
Trigger sources, a set of OR-ed TS_CH* values.
Since
0.4.0
uint64_t GenSetTriggerSourceOR ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerSourceMask 
)

Set trigger sources OR.

Deprecated:
Will be removed in version 1.0, see trigger input(s).
Parameters
hDeviceA device handle.
qwTriggerSourceMaskTrigger sources, a set of OR-ed TS_CH* values.
Returns
Trigger sources, a set of OR-ed TS_CH* values.
Since
0.4.0