LibTiePie  0.4.0
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Groups Pages
Timebase

Functions

double ScpGetPreSampleRatio (TpDeviceHandle_t hDevice)
 Get pre sample ratio.
 
double ScpSetPreSampleRatio (TpDeviceHandle_t hDevice, double dPreSampleRatio)
 Set pre sample ratio.
 
uint64_t ScpGetTriggerHoldOffCountMax (TpDeviceHandle_t hDevice)
 Get maximum trigger hold off count in samples.
 
uint64_t ScpGetTriggerHoldOffCountMaxEx (TpDeviceHandle_t hDevice, uint32_t dwMeasureMode)
 Get maximum trigger hold off count in samples by measure mode.
 
uint64_t ScpGetTriggerHoldOffCount (TpDeviceHandle_t hDevice)
 Get trigger hold off count in samples.
 
uint64_t ScpSetTriggerHoldOffCount (TpDeviceHandle_t hDevice, uint64_t qwTriggerHoldOffCount)
 Set trigger hold off count in samples.
 
uint64_t ScpGetRecordLengthMax (TpDeviceHandle_t hDevice)
 Get maximum record length.
 
uint64_t ScpGetRecordLengthMaxEx (TpDeviceHandle_t hDevice, uint32_t dwMeasureMode, uint8_t byResolution)
 Get maximum record length by measure mode.
 
uint64_t ScpGetRecordLength (TpDeviceHandle_t hDevice)
 Get record length.
 
uint64_t ScpSetRecordLength (TpDeviceHandle_t hDevice, uint64_t qwRecordLength)
 Set record length.
 
uint64_t ScpVerifyRecordLength (TpDeviceHandle_t hDevice, uint64_t qwRecordLength)
 Verify record length.
 
uint64_t ScpVerifyRecordLengthEx (TpDeviceHandle_t hDevice, uint64_t qwRecordLength, uint32_t dwMeasureMode, uint8_t byResolution, uint64_t qwActiveChannelMask)
 Verify record length by measure mode, resolution and active channels.
 
double ScpGetSampleFrequencyMax (TpDeviceHandle_t hDevice)
 Get instruments maximum sample frequency.
 
double ScpGetSampleFrequency (TpDeviceHandle_t hDevice)
 Get sample frequency.
 
double ScpSetSampleFrequency (TpDeviceHandle_t hDevice, double dSampleFrequency)
 Set sample frequency.
 
double ScpVerifySampleFrequency (TpDeviceHandle_t hDevice, double dSampleFrequency)
 Verify sample frequency.
 
double ScpVerifySampleFrequencyEx (TpDeviceHandle_t hDevice, double dSampleFrequency, uint32_t dwMeasureMode, uint8_t byResolution, uint64_t qwActiveChannelMask)
 Verify sample frequency.
 

Detailed Description

Function Documentation

double ScpGetPreSampleRatio ( TpDeviceHandle_t  hDevice)

Get pre sample ratio.

Parameters
hDeviceA device handle.
Returns
Pre sample ratio 0..1.
uint64_t ScpGetRecordLength ( TpDeviceHandle_t  hDevice)

Get record length.

Parameters
hDeviceA device handle.
Returns
Record length.
uint64_t ScpGetRecordLengthMax ( TpDeviceHandle_t  hDevice)

Get maximum record length.

Parameters
hDeviceA device handle.
Returns
Maximum record length.
uint64_t ScpGetRecordLengthMaxEx ( TpDeviceHandle_t  hDevice,
uint32_t  dwMeasureMode,
uint8_t  byResolution 
)

Get maximum record length by measure mode.

Parameters
hDeviceA device handle.
dwMeasureModeMeasure mode, a MM_* value.
byResolutionResolution in bits.
Returns
Maximum record length.
double ScpGetSampleFrequency ( TpDeviceHandle_t  hDevice)

Get sample frequency.

Parameters
hDeviceA device handle.
Returns
Sample frequency in Hz.
double ScpGetSampleFrequencyMax ( TpDeviceHandle_t  hDevice)

Get instruments maximum sample frequency.

Parameters
hDeviceA device handle.
Returns
Maximum sample frequency.
uint64_t ScpGetTriggerHoldOffCount ( TpDeviceHandle_t  hDevice)

Get trigger hold off count in samples.

Parameters
hDeviceA device handle.
Returns
Trigger hold off count in samples.
uint64_t ScpGetTriggerHoldOffCountMax ( TpDeviceHandle_t  hDevice)

Get maximum trigger hold off count in samples.

Parameters
hDeviceA device handle.
Returns
Maximum trigger hold off count in samples.
uint64_t ScpGetTriggerHoldOffCountMaxEx ( TpDeviceHandle_t  hDevice,
uint32_t  dwMeasureMode 
)

Get maximum trigger hold off count in samples by measure mode.

Parameters
hDeviceA device handle.
dwMeasureModeMeasure mode, a MM_* value.
Returns
Maximum trigger hold off count in samples.
double ScpSetPreSampleRatio ( TpDeviceHandle_t  hDevice,
double  dPreSampleRatio 
)

Set pre sample ratio.

Parameters
hDeviceA device handle.
dPreSampleRatioPre sample ratio 0..1.
Returns
Pre sample ratio 0..1.
uint64_t ScpSetRecordLength ( TpDeviceHandle_t  hDevice,
uint64_t  qwRecordLength 
)

Set record length.

Parameters
hDeviceA device handle.
qwRecordLengthRecord length.
Returns
Record length.
double ScpSetSampleFrequency ( TpDeviceHandle_t  hDevice,
double  dSampleFrequency 
)

Set sample frequency.

Parameters
hDeviceA device handle.
dSampleFrequencySample frequency in Hz.
Returns
Sample frequency in Hz.
uint64_t ScpSetTriggerHoldOffCount ( TpDeviceHandle_t  hDevice,
uint64_t  qwTriggerHoldOffCount 
)

Set trigger hold off count in samples.

Parameters
hDeviceA device handle.
qwTriggerHoldOffCountTrigger hold off count in samples.
Returns
Trigger hold off count in samples.
uint64_t ScpVerifyRecordLength ( TpDeviceHandle_t  hDevice,
uint64_t  qwRecordLength 
)

Verify record length.

Parameters
hDeviceA device handle.
qwRecordLengthRecord length.
Returns
Record length.
uint64_t ScpVerifyRecordLengthEx ( TpDeviceHandle_t  hDevice,
uint64_t  qwRecordLength,
uint32_t  dwMeasureMode,
uint8_t  byResolution,
uint64_t  qwActiveChannelMask 
)

Verify record length by measure mode, resolution and active channels.

Parameters
hDeviceA device handle.
qwRecordLengthRecord length.
dwMeasureModeMeasure mode, a MM_* value.
byResolutionResolution in bits.
qwActiveChannelMaskBit mask with active channels.
Returns
Record length.
double ScpVerifySampleFrequency ( TpDeviceHandle_t  hDevice,
double  dSampleFrequency 
)

Verify sample frequency.

Parameters
hDeviceA device handle.
dSampleFrequencySample frequency in Hz.
Returns
Sample frequency in Hz when set.
double ScpVerifySampleFrequencyEx ( TpDeviceHandle_t  hDevice,
double  dSampleFrequency,
uint32_t  dwMeasureMode,
uint8_t  byResolution,
uint64_t  qwActiveChannelMask 
)

Verify sample frequency.

Parameters
hDeviceA device handle.
dSampleFrequencySample frequency in Hz.
dwMeasureModeMeasure mode, a MM_* value.
byResolutionResolution in bits.
qwActiveChannelMaskBit mask with active channels.
Returns
Sample frequency in Hz when set.