MX Foundation 4
MXF_CSDB_SAMPREC Struct Reference

CSDB Sampling Record. More...

#include <mxf_class_csdb.h>

Data Fields

uint64 timeTag
 
uint32 control
 
uint32 rate
 
uint32 errorCount
 
uint8 data [12]
 

Detailed Description

The record structure MXF_CSDB_SAMPREC is returned by the sampling service with data and status of last record(s) received on the port.

Examples:
csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, and csdb_rx_sampling.cs.

Field Documentation

uint64 MXF_CSDB_SAMPREC::timeTag

Specify the time when the sampling record has been received by the device. It is an absolute time expressed on the timebase set for the device. The timetag may also be disabled by the KMXF_CSDB_RX_TIMETAG_ENABLE attribute.

Examples:
csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, and csdb_rx_sampling.cs.
uint32 MXF_CSDB_SAMPREC::control

The control field defines the condition under which the related record data was received.

Bit Constant Meaning
MXF_CSDB_RX_REC_CTRL_PARITY_ERROR A parity error was detected in the incoming message.
MXF_CSDB_RX_REC_CTRL_STOPBIT_ERROR A stop bit error was detected in the incoming message.

A control of zero indicates that no errors was found while receiving data.

uint32 MXF_CSDB_SAMPREC::rate

Time between the reception of the last two records expressed in the resolution of the process time base (usec or nsec). The maximum is about 1 sec; 4000000 in nsec or 4000 seconds in usec.

uint32 MXF_CSDB_SAMPREC::errorCount

The number of parity and stop bit error.

uint8 MXF_CSDB_SAMPREC::data[12]
Updated 10/23/2023