LibTiePie  0.4.1
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Groups Pages
Deprecated

Functions

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

Detailed Description

Function Documentation

bool8_t GenGetAutoRanging ( TpDeviceHandle_t  hDevice)

Get auto ranging.

Deprecated:
Will be removed in version 0.5.0, use: GenGetAmplitudeAutoRanging().
Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
uint32_t GenGetMode ( TpDeviceHandle_t  hDevice)

Get generator frequency mode.

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

Get supported generator frequency modes.

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

Get supported generator frequency modes by signal type.

Deprecated:
Will be removed in version 0.5.0, use: GenGetFrequencyModesEx().
Parameters
hDeviceA device handle.
dwSignalTypeA ST_* signal type.
Returns
Supported generator frequency modes by signal type, a set of OR-ed FM_* values.
double GenGetRange ( TpDeviceHandle_t  hDevice)

Get range.

Deprecated:
Will be removed in version 0.5.0, use: GenGetAmplitudeRange().
Parameters
hDeviceA device handle.
Returns
Range.
uint32_t GenGetRanges ( TpDeviceHandle_t  hDevice,
double *  pList,
uint32_t  dwLength 
)

Get supported ranges.

Example:

uint32_t dwRangeCount = GenGetRanges( hDevice , NULL , 0 );
double Ranges[ dwRangeCount ];
dwRangeCount = GenGetRanges( hDevice , Ranges , dwRangeCount );
printf( "GenGetRanges:\n" );
for( uint32_t i = 0 ; i < dwRangeCount ; i++ )
printf( "- %f\n" , Ranges[ i ] );
Deprecated:
Will be removed in version 0.5.0, use: GenGetAmplitudeRanges().
Parameters
hDeviceA device handle.
pListPointer to array.
dwLengthNumber of elements in array.
Returns
Total number of ranges.
uint64_t GenGetTriggerSourceAND ( TpDeviceHandle_t  hDevice)

Get trigger sources AND.

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

Get trigger sources OR.

Deprecated:
Will be removed in version 0.5.0, see trigger input(s).
Parameters
hDeviceA device handle.
Returns
Trigger sources, a set of OR-ed TS_* values.
uint64_t GenGetTriggerSources ( TpDeviceHandle_t  hDevice)

Get supported trigger sources.

Deprecated:
Will be removed in version 0.5.0, see trigger input(s).
Parameters
hDeviceA device handle.
Returns
Supported trigger sources, a set of OR-ed TS_* values.
bool8_t GenSetAutoRanging ( TpDeviceHandle_t  hDevice,
bool8_t  bEnable 
)

Set auto ranging.

Deprecated:
Will be removed in version 0.5.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.
uint32_t GenSetMode ( TpDeviceHandle_t  hDevice,
uint32_t  dwMode 
)

Set generator frequency mode.

Deprecated:
Will be removed in version 0.5.0, use: GenSetFrequencyMode().
Parameters
hDeviceA device handle.
dwModeGenerator frequency mode, a FM_* value.
Returns
Generator frequency mode, a FM_* value.
double GenSetRange ( TpDeviceHandle_t  hDevice,
double  dRange 
)

Set range.

Example:

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

Set trigger sources AND.

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

Set trigger sources OR.

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