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

Functions

uint64_t ScpGetData (TpDeviceHandle_t hDevice, float **pBuffers, uint16_t wChannelCount, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get measurement data.
 
uint64_t ScpGetData1Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get measurement data.
 
uint64_t ScpGetData2Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get measurement data.
 
uint64_t ScpGetData3Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, float *pBufferCh3, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get measurement data.
 
uint64_t ScpGetData4Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, float *pBufferCh3, float *pBufferCh4, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get measurement data.
 
uint64_t ScpGetDataRaw (TpDeviceHandle_t hDevice, void **pBuffers, uint16_t wChannelCount, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get raw measurement data.
 
uint64_t ScpGetDataRaw1Ch (TpDeviceHandle_t hDevice, void *pBufferCh1, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get raw measurement data.
 
uint64_t ScpGetDataRaw2Ch (TpDeviceHandle_t hDevice, void *pBufferCh1, void *pBufferCh2, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get raw measurement data.
 
uint64_t ScpGetDataRaw3Ch (TpDeviceHandle_t hDevice, void *pBufferCh1, void *pBufferCh2, void *pBufferCh3, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get raw measurement data.
 
uint64_t ScpGetDataRaw4Ch (TpDeviceHandle_t hDevice, void *pBufferCh1, void *pBufferCh2, void *pBufferCh3, void *pBufferCh4, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get raw measurement data.
 
bool8_t ScpChIsRangeMaxReachable (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the ranges maximum is reachable.
 
uint32_t ScpChGetDataRawType (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get raw data type.
 
uint64_t ScpGetValidPreSampleCount (TpDeviceHandle_t hDevice)
 Get number of valid pre samples.
 
void ScpChGetDataValueRange (TpDeviceHandle_t hDevice, uint16_t wCh, double *pMin, double *pMax)
 Get possible minimum and maximum value for current data.
 
double ScpChGetDataValueMax (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get possible maximum value for current data.
 
double ScpChGetDataValueMin (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get possible minimum value for current data.
 
void ScpChGetDataRawValueRange (TpDeviceHandle_t hDevice, uint16_t wCh, int64_t *pMin, int64_t *pZero, int64_t *pMax)
 Get possible raw data minimum, equal to zero and maximum values.
 
int64_t ScpChGetDataRawValueMax (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get possible raw data maximum value.
 
int64_t ScpChGetDataRawValueZero (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get raw data value which equals zero.
 
int64_t ScpChGetDataRawValueMin (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get possible raw data minimum value.
 

Detailed Description

Function Documentation

uint32_t ScpChGetDataRawType ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get raw data type.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Raw data type.
int64_t ScpChGetDataRawValueMax ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get possible raw data maximum value.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Possible raw data maximum value.
See Also
ScpChGetDataRawValueMin
ScpChGetDataRawValueZero
ScpChGetDataRawValueRange
int64_t ScpChGetDataRawValueMin ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get possible raw data minimum value.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Possible raw data minimum value.
See Also
ScpChGetDataRawValueZero
ScpChGetDataRawValueMax
ScpChGetDataRawValueRange
void ScpChGetDataRawValueRange ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
int64_t *  pMin,
int64_t *  pZero,
int64_t *  pMax 
)

Get possible raw data minimum, equal to zero and maximum values.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
pMinPointer to buffer for possible minimum raw data value, or NULL.
pZeroPointer to buffer for equal to zero raw data value, or NULL.
pMaxPointer to buffer for possible maximum raw data value, or NULL.
See Also
ScpChGetDataRawValueMin Pointer to buffer for possible minimum raw data value, or NULL.
ScpChGetDataRawValueZero Pointer to buffer for equal to zero raw data value, or NULL.
ScpChGetDataRawValueMax Pointer to buffer for possible maximum raw data value, or NULL.
int64_t ScpChGetDataRawValueZero ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get raw data value which equals zero.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Raw data value which equals zero.
See Also
ScpChGetDataRawValueMin
ScpChGetDataRawValueMax
ScpChGetDataRawValueRange
double ScpChGetDataValueMax ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get possible maximum value for current data.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Possible maximum value.
See Also
ScpChGetDataValueMin
ScpChGetDataValueRange
double ScpChGetDataValueMin ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Get possible minimum value for current data.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
Possible minimum value.
See Also
ScpChGetDataValueMax
ScpChGetDataValueRange
void ScpChGetDataValueRange ( TpDeviceHandle_t  hDevice,
uint16_t  wCh,
double *  pMin,
double *  pMax 
)

Get possible minimum and maximum value for current data.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
pMinPointer to buffer for possible minimum value or NULL.
pMaxPointer to buffer for possible maximum value or NULL.
See Also
ScpChGetDataValueMin
ScpChGetDataValueMax
bool8_t ScpChIsRangeMaxReachable ( TpDeviceHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the ranges maximum is reachable.

Parameters
hDeviceA device handle.
wChChannel number, 0..ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if reachable, BOOL8_FALSE otherwise.
uint64_t ScpGetData ( TpDeviceHandle_t  hDevice,
float **  pBuffers,
uint16_t  wChannelCount,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get measurement data.

Parameters
hDeviceA device handle.
pBuffersPointer to buffer with pointers to buffer for channel data, pointer buffer may contain NULL pointers.
wChannelCountNumber of pointers in pointer buffer.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetData1Ch ( TpDeviceHandle_t  hDevice,
float *  pBufferCh1,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetData2Ch ( TpDeviceHandle_t  hDevice,
float *  pBufferCh1,
float *  pBufferCh2,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetData3Ch ( TpDeviceHandle_t  hDevice,
float *  pBufferCh1,
float *  pBufferCh2,
float *  pBufferCh3,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
pBufferCh3Pointer to buffer for channel 3 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetData4Ch ( TpDeviceHandle_t  hDevice,
float *  pBufferCh1,
float *  pBufferCh2,
float *  pBufferCh3,
float *  pBufferCh4,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
pBufferCh3Pointer to buffer for channel 3 data or NULL.
pBufferCh4Pointer to buffer for channel 4 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetDataRaw ( TpDeviceHandle_t  hDevice,
void **  pBuffers,
uint16_t  wChannelCount,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get raw measurement data.

Parameters
hDeviceA device handle.
pBuffersPointer to buffer with pointers to buffer for channel data, pointer buffer may contain NULL pointers.
wChannelCountNumber of pointers in pointer buffer.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetDataRaw1Ch ( TpDeviceHandle_t  hDevice,
void *  pBufferCh1,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get raw measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetDataRaw2Ch ( TpDeviceHandle_t  hDevice,
void *  pBufferCh1,
void *  pBufferCh2,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get raw measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetDataRaw3Ch ( TpDeviceHandle_t  hDevice,
void *  pBufferCh1,
void *  pBufferCh2,
void *  pBufferCh3,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get raw measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
pBufferCh3Pointer to buffer for channel 3 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetDataRaw4Ch ( TpDeviceHandle_t  hDevice,
void *  pBufferCh1,
void *  pBufferCh2,
void *  pBufferCh3,
void *  pBufferCh4,
uint64_t  qwStartIndex,
uint64_t  qwSampleCount 
)

Get raw measurement data.

Parameters
hDeviceA device handle.
pBufferCh1Pointer to buffer for channel 1 data or NULL.
pBufferCh2Pointer to buffer for channel 2 data or NULL.
pBufferCh3Pointer to buffer for channel 3 data or NULL.
pBufferCh4Pointer to buffer for channel 4 data or NULL.
qwStartIndex
qwSampleCountNumber of samples to write into buffer.
Returns
Number of samples ready.
uint64_t ScpGetValidPreSampleCount ( TpDeviceHandle_t  hDevice)

Get number of valid pre samples.

Parameters
hDeviceA device handle.
Returns
Number of valid pre samples.