Description

Functions to control the trigger hold off of an oscilloscope.

Trigger hold off defines a period of time after starting a measurement in which the oscilloscope will not respond to triggers. It is used to get stable triggering on periodical signals that have multiple moments that would otherwise generate a trigger.

When pre samples are selected, trigger hold off can be used to ensure that all pre samples are measured before a trigger occurs. Set the trigger hold off to TH_ALLPRESAMPLES to measure all pre samples and have no invalid pre samples.

Trigger hold off is set in a number of samples. By default the trigger hold off is set to: 0 samples.

Functions
bool8_t	ScpHasTriggerHoldOff (TpDeviceHandle_t hDevice)
	Check whether the oscilloscope has trigger hold off support with the currently selected measure mode. More...

uint64_t	ScpGetTriggerHoldOffCountMax (TpDeviceHandle_t hDevice)
	Get the maximum trigger hold off count in samples, for a specified oscilloscope. More...

uint64_t	ScpGetTriggerHoldOffCount (TpDeviceHandle_t hDevice)
	Get the trigger hold off count in samples, for a specified oscilloscope. More...

uint64_t	ScpSetTriggerHoldOffCount (TpDeviceHandle_t hDevice, uint64_t qwTriggerHoldOffCount)
	Set the trigger hold off count in samples, for a specified oscilloscope. More...

Function Documentation

bool8_t ScpHasTriggerHoldOff ( TpDeviceHandle_t hDevice )

Check whether the oscilloscope has trigger hold off support with the currently selected measure mode.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: BOOL8_TRUE if the oscilloscope has trigger hold off support, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since: 0.5

uint64_t ScpGetTriggerHoldOffCountMax ( TpDeviceHandle_t hDevice )

Get the maximum trigger hold off count in samples, for a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The maximum trigger hold off count in samples.

Status values

NOT_SUPPORTED	The oscilloscope does not support trigger hold off.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpHasTriggerHoldOff; ScpGetTriggerHoldOffCount; ScpSetTriggerHoldOffCount

Since: 0.4.0

uint64_t ScpGetTriggerHoldOffCount ( TpDeviceHandle_t hDevice )

Get the trigger hold off count in samples, for a specified oscilloscope.

Parameters

[in] hDevice A device handle identifying the oscilloscope.

Returns: The currently set trigger hold off count in samples.

Status values

NOT_SUPPORTED	The oscilloscope does not support trigger hold off.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpHasTriggerHoldOff; ScpGetTriggerHoldOffCountMax; ScpSetTriggerHoldOffCount

Since: 0.4.0

uint64_t ScpSetTriggerHoldOffCount	(	TpDeviceHandle_t	hDevice,
		uint64_t	qwTriggerHoldOffCount
	)

Set the trigger hold off count in samples, for a specified oscilloscope.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	qwTriggerHoldOffCount	The required trigger hold off count in samples.

Returns: The actually set trigger hold off count in samples.

Status values

VALUE_CLIPPED	The requested trigger hold off count is outside the valid range and clipped to the closest limit.
NOT_SUPPORTED	The oscilloscope does not support trigger hold off.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpHasTriggerHoldOff; ScpGetTriggerHoldOffCountMax; ScpGetTriggerHoldOffCount

Since: 0.4.0