Gx3748EventCaptureGetMode

Purpose

Returns the specified event capture memory mode.

Syntax

Gx3748EventCaptureGetMode (nHandle, nMemory, pnMode, 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.   
pnMode
PSHORT
The specified event capture memory mode:
0.      GX3748_EVENT_CAPTURE_MODE_TRANSITIONS: Once the specified event capture memory is enabled any input voltage transition (low to high or vice versa) will record the timestamp and the voltage level at that time (default). See comments for more details.
1.   GX3748_EVENT_CAPTURE_MODE_CONTINUOUS: Once enabled, the memory will record every sampling rate the timestamp and the voltage level at that time. See comments for more details.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the specified event capture memory mode.

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 elements 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, and returns the memory modes:

 

SHORT nHandle, nStatus;

SHORT nMode;

 

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

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

 

See Also

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