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

Functions

double GenGetAmplitudeMax (TpDeviceHandle_t hDevice)
 Get maximum signal amplitude.
 
double GenGetAmplitudeMin (TpDeviceHandle_t hDevice)
 Get minimum signal amplitude.
 
double GenGetAmplitude (TpDeviceHandle_t hDevice)
 Get signal amplitude.
 
double GenSetAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
 Set signal amplitude.
 
double GenVerifyAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
 Verify signal amplitude.
 
bool8_t GenGetAmplitudeAutoRanging (TpDeviceHandle_t hDevice)
 Get auto ranging.
 
bool8_t GenSetAmplitudeAutoRanging (TpDeviceHandle_t hDevice, bool8_t bEnable)
 Set auto ranging.
 
uint32_t GenGetAmplitudeRanges (TpDeviceHandle_t hDevice, double *pList, uint32_t dwLength)
 Get supported ranges.
 
double GenGetAmplitudeRange (TpDeviceHandle_t hDevice)
 Get range.
 
double GenSetAmplitudeRange (TpDeviceHandle_t hDevice, double dRange)
 Set range.
 

Detailed Description

Function Documentation

double GenGetAmplitude ( TpDeviceHandle_t  hDevice)

Get signal amplitude.

Parameters
hDeviceA device handle.
Returns
Signal amplitude.
bool8_t GenGetAmplitudeAutoRanging ( TpDeviceHandle_t  hDevice)

Get auto ranging.

Parameters
hDeviceA device handle.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
double GenGetAmplitudeMax ( TpDeviceHandle_t  hDevice)

Get maximum signal amplitude.

Parameters
hDeviceA device handle.
Returns
Maximum signal amplitude.
double GenGetAmplitudeMin ( TpDeviceHandle_t  hDevice)

Get minimum signal amplitude.

Parameters
hDeviceA device handle.
Returns
Minimum signal amplitude.
double GenGetAmplitudeRange ( TpDeviceHandle_t  hDevice)

Get range.

Parameters
hDeviceA device handle.
Returns
Range.
uint32_t GenGetAmplitudeRanges ( TpDeviceHandle_t  hDevice,
double *  pList,
uint32_t  dwLength 
)

Get supported ranges.

Example:

uint32_t dwRangeCount = GenGetAmplitudeRanges( hDevice , NULL , 0 );
double Ranges[ dwRangeCount ];
dwRangeCount = GenGetAmplitudeRanges( hDevice , Ranges , dwRangeCount );
printf( "GenGetAmplitudeRanges:\n" );
for( uint32_t i = 0 ; i < dwRangeCount ; i++ )
printf( "- %f\n" , Ranges[ i ] );
Parameters
hDeviceA device handle.
pListPointer to array.
dwLengthNumber of elements in array.
Returns
Total number of ranges.
double GenSetAmplitude ( TpDeviceHandle_t  hDevice,
double  dAmplitude 
)

Set signal amplitude.

Parameters
hDeviceA device handle.
dAmplitudeSignal amplitude.
Returns
Signal amplitude.
bool8_t GenSetAmplitudeAutoRanging ( TpDeviceHandle_t  hDevice,
bool8_t  bEnable 
)

Set auto ranging.

Parameters
hDeviceA device handle.
bEnableBOOL8_TRUE to enable or BOOL8_FALSE to disable.
Returns
BOOL8_TRUE if enabled, BOOL8_FALSE if disabled.
double GenSetAmplitudeRange ( TpDeviceHandle_t  hDevice,
double  dRange 
)

Set range.

Example:

double dRange = 10;
dRange = GenSetAmplitudeRange( hDevice , dRange );
printf( "GenSetAmplitudeRange = %f" , dRange );
Parameters
hDeviceA device handle.
dRangeMaximum value that must fit within range.
Returns
Range.
double GenVerifyAmplitude ( TpDeviceHandle_t  hDevice,
double  dAmplitude 
)

Verify signal amplitude.

Parameters
hDeviceA device handle.
dAmplitudeSignal amplitude.
Returns
Signal amplitude.