MX Foundation 4
MXF_PULSE_DATAREC Struct Reference

Pulse Transmit Record. More...

#include <mxf_class_pulse.h>

Data Fields

uint64 timeTag
 
uint32 control
 
uint32 repeatCount
 
uint32 mode
 
uint32 highDuration
 
uint32 lowDuration
 
uint32 reserved
 

Detailed Description

This record structure is used to send pulse data.

Examples:
pulse.c.

Field Documentation

MXF_PULSE_DATAREC::timeTag

For transmit operation, the time tag allows the application to specify the time when the state is to be set. Depending on the usage the time tag can be optional.

Examples:
pulse.c.
MXF_PULSE_DATAREC::control

Reserved for future use, must be set to 0.

Examples:
pulse.c.
MXF_PULSE_DATAREC::repeatCount

In transmission indicates the number of time the pulse schedule is repeated. Must be set to 1 if pulse schedule mode is not used. Repeat count of 0 in pulse schedule mode means the pulse is repeated forever.

Examples:
pulse.c.
MXF_PULSE_DATAREC::mode

Used in transmission to control start and stop of pulse schedule.

Bit Constant Meaning
MXF_PULSE_DATAREC_MODE_LOW Sets TX line to low. Useful to stop schedule.
MXF_PULSE_DATAREC_MODE_HIGH Sets TX line to high. Useful to stop schedule.
MXF_PULSE_DATAREC_MODE_LOW_EOP Sets TX line to low on next end of pulse. Useful to stop schedule.
MXF_PULSE_DATAREC_MODE_HIGH_EOP Sets TX line to high on next end of pulse. Useful to stop schedule.
MXF_PULSE_DATAREC_MODE_SCHED_START Starts a pulse schedule. Uses highDuration and lowDuration fields. Pulse schedule always starts with the high duration (high level).
MXF_PULSE_DATAREC_MODE_SCHED_START_EOP Starts PULSE schedule on next end of pulse. Uses highDuration and lowDuration fields.
MXF_PULSE_DATAREC_MODE_SCHED_START_EOR Starts PULSE schedule on end of the current repeat count. Uses highDuration and lowDuration fields.
Examples:
pulse.c.
MXF_PULSE_DATAREC::highDuration

High Duration of the pulse (Ticks count of 125 nsec, range: 125 - 2^24 [125 nsec to 2,097152 sec]). Used only with pulse schedule mode, must be set to 0 when pulse schedule mode is not used.

Examples:
pulse.c.
MXF_PULSE_DATAREC::lowDuration

Low Duration of the pulse (Ticks count of 125 nsec, range: 125 - 2^24 [125 nsec to 2,097152 sec]). Used only with pulse schedule mode , must be set to 0 when pulse schedule mode is not used.

Examples:
pulse.c.
MXF_PULSE_DATAREC::reserved

Reserved for future use, must be set to 0.

Updated 10/23/2023