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

Description

This section contains all record length related functions.

The record length defines the number of samples in a measurement. With a given sample frequency, the record length determines the duration of the measurement. Increasing the record length, will increase the total measuring time. The result is that more of the measured signal is visible.

The maximum supported record length depends on the used instrument and its configuration. Use ScpGetRecordLengthMax to determine the maximum supported record length of a device.

The record length can be affected by changing the channel enable, resolution, measure mode and/or sample frequency.

By default the record length is set to: 5000 samples.

Functions

uint64_t ScpGetRecordLengthMax (TpDeviceHandle_t hDevice)
 Get the maximum supported record length of a specified device. More...
 
uint64_t ScpGetRecordLength (TpDeviceHandle_t hDevice)
 Get the currently selected record length. More...
 
uint64_t ScpSetRecordLength (TpDeviceHandle_t hDevice, uint64_t qwRecordLength)
 Set the record length. More...
 

Function Documentation

uint64_t ScpGetRecordLengthMax ( TpDeviceHandle_t  hDevice)

Get the maximum supported record length of a specified device.

Parameters
hDeviceA device handle.
Returns
The maximum supported record length.
Since
0.4.0
uint64_t ScpGetRecordLength ( TpDeviceHandle_t  hDevice)

Get the currently selected record length.

Parameters
hDeviceA device handle.
Returns
The currently selected record length, in samples.
Since
0.4.0
uint64_t ScpSetRecordLength ( TpDeviceHandle_t  hDevice,
uint64_t  qwRecordLength 
)

Set the record length.

Parameters
hDeviceA device handle.
qwRecordLengthThe required record length, in samples.
Returns
The actually set record length, in samples.
Remarks
Changing the record length may affect the segment count.
Since
0.4.0