Gx3748EventCaptureGetHoldoffTime

Purpose

Returns the specified event capture memory Holdoff Time in uSec.

Syntax

Gx3748EventCaptureGetHoldoffTime (nHandle, nMemory, pdwHoldoffTime, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX3748 board.
nMemory
SHORT
Specified memory number, memory number are as follows:
0.      GX3748_EVENT_CAPTURE_MEMORY0: memory number 0.
1.      GX3748_EVENT_CAPTURE_MEMORY1: memory number 1.
2.    GX3748_EVENT_CAPTURE_MEMORY2: memory number 2.   
pdwHoldoffTime
PDWORD
Returns the specified event capture memory Holdoff Time in uSec. Holdoff Time is the minimum time that must pass after an event was detected before the next event can be detected (required FW 0x17 and above).
Minimum Holdoff Time is 0 uSec, maximum Holdoff Time is 1048575 uSec (~1Sec).
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the specified event capture memory Holdoff Time in uSec. This function should be used in cases the input signal has a very slow slop or noisy. By capturing the first threshold crossing, and disregarding additional crossing we can filter events that are the result of noisy and unstable input signals.

There are 3 independent event capture memories. Each memory can record input events from any of the channels’ groups by setting the memory source, Gx3748EventCaptureSetSource() API. The user can read any number of elements from any of the memories using the Gx3748EventCaptureReadMemory() API., as well as the current number of recorded element by calling the Gx3748EventCaptureReadMemoryCount() API. Whenever the user changes the specified event capture memory input source (group and channel), the content of that memory and the recorded element counter will be cleared. Whenever the user changes the specified event capture memory mode, Gx3748EventCaptureSetMode() API , the content of that memory and the recorded element counter will be cleared.

Note: Each event capture memory can have up to 12288 recorded everts, and ignore any additional samples.

Example

The following example sets event capture memory 0 mode to Transitions, sets the Holdoff Time to 100 uSec and returns the memory modes:

 

SHORT nHandle, nStatus;

SHORT nMode;

DWORD dwHoldoffTime;

 

Gx3748EventCaptureSetMode (nHandle, GX3748_EVENT_CAPTURE_MEMORY0, GX3748_EVENT_CAPTURE_MODE_TRANSITIONS, &nStatus);

Gx3748EventCaptureSetHoldoffTime nHandle, GX3748_EVENT_CAPTURE_MEMORY0, 100, &nStatus);

Gx3748EventCaptureGetMode (nHandle, GX3748_EVENT_CAPTURE_MEMORY0, &nMode, &nStatus);

Gx3748EventCaptureGetHoldoffTime nHandle, GX3748_EVENT_CAPTURE_MEMORY0, &dwHoldoffTime, &nStatus);

 

See Also

Gx3748EventCaptureClearMemory, Gx3748EventCaptureReadMemory, Gx3748EventCaptureReadMemoryCount, Gx3748EventCaptureReadTimestampCounter, Gx3748EventCaptureResetTimestampCounter, Gx3748EventCaptureSetMode,  Gx3748EventCaptureSetSampleRate, Gx3748EventCaptureSetSource, Gx3748EventCaptureSetState, Gx3748EventCaptureSoftwareTrigger, Gx3748EventCaptureSetHoldoffTime, GxFpgaGetErrorString