Functions
uint32	mxfRxAcqBufferAlloc (HMXF_HANDLE handle, uint64 size, HMXF_BUFFER buffer, uint64 allocated)

uint32	mxfRxAcqBufferGet (HMXF_HANDLE handle, HMXF_BUFFER *buffer)

uint32	mxfRxAcqBufferFree (HMXF_BUFFER buffer)

uint32	mxfRxAcqBufferStatusGet (HMXF_BUFFER buffer, uint64 status, uint64 msgCount, uint64 pendingBytes, uint64 freeBytes)

uint32	mxfRxAcqBufferInfoGet (HMXF_BUFFER buffer, HMXF_HANDLE *handle)

uint32	mxfRxAcqModeGet (HMXF_BUFFER buffer, uint64 *mode)

uint32	mxfRxAcqModeSet (HMXF_BUFFER buffer, uint64 mode)

uint32	mxfRxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 options, uint64 maxCount, uint64 count, void msg)

uint32	mxfRxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 options, uint64 select, uint64 count, void *msg)

uint32	mxfRxAcqStart (HMXF_BUFFER buffer, uint64 flags, uint64 startTime, uint64 duration)

uint32	mxfRxAcqStop (HMXF_BUFFER buffer)

uint32	mxfRxAcqClose (HMXF_BUFFER buffer)

uint32	mxfRxAcqStopTimeGet (HMXF_BUFFER buffer, uint64 *stopTime)

uint32	mxfRxAcqClear (HMXF_BUFFER buffer)

uint32	mxfRxAcqRead (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, uint64 status, uint64 msgCount, uint64 byteCount, void rec)

uint32	mxfRxAcqReadAsync (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, void hostBuffer, MXF_ASYNCHRONOUS_CALLBACK readCompletion, void context)

uint32	mxfRxAcqTrigEnableGet (HMXF_BUFFER buffer, uint64 *state)

uint32	mxfRxAcqTrigEnableSet (HMXF_BUFFER buffer, uint64 state)

uint32	mxfRxAcqTrigSet (HMXF_BUFFER buffer, HMXF_COND_LIST condList, uint64 pretrigCount)

uint32	mxfRxAcqTrigTimeGet (HMXF_BUFFER buffer, uint64 *time)

uint32	mxfRxAcqTrigConditionListAlloc (HMXF_SERVER server, HMXF_COND_LIST *condList)

uint32	mxfRxAcqTrigConditionListFree (HMXF_COND_LIST condList)

uint32	mxfRxAcqTrigConditionListExprSet (HMXF_COND_LIST condList, uint64 expression)

uint32	mxfRxAcqTrigConditionAdd (HMXF_COND_LIST condList, uint64 id, void *param)

uint32	mxfRxAcqBufferAsyncEventInit (HMXF_BUFFER buffer, uint64 almostFull, void *context, MXF_ASYNCEVENT_BUFFER_HANDLER callback)

uint32	mxfRxAcqBufferAsyncEventTerminate (HMXF_BUFFER buffer)

uint32	mxfRxMsgChannelAsyncEventInit (HMXF_CHANNEL channel, void *context, MXF_ASYNCEVENT_RXMSG_HANDLER callback)

uint32	mxfRxMsgChannelAsyncEventTerminate (HMXF_CHANNEL channel)

uint32	mxfRxMsgAsyncEventMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, void *msg)

uint32	mxfRxMsgAsyncEventMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, void msg)

uint32	mxfRxErrChannelAsyncEventInit (HMXF_CHANNEL channel, void *context, MXF_ASYNCEVENT_RXERR_HANDLER callback)

uint32	mxfRxErrChannelAsyncEventTerminate (HMXF_CHANNEL channel)

Detailed Description

Function Documentation

uint32 mxfRxAcqBufferAlloc	(	HMXF_HANDLE	handle,
		uint64	size,
		HMXF_BUFFER *	buffer,
		uint64 *	allocated
	)

C#: public static extern UInt32 mxfRxAcqBufferAlloc(UInt64 handle, UInt64 size, out UInt64 buffer, out UInt64 allocated);

public static extern UInt32 mxfRxAcqBufferAlloc(UInt64 handle, UInt64 size, out UInt64 buffer, IntPtr allocated);

Allocates an acquisition buffer area for reception.

Parameters

[in]	handle	channel handle (module handle for FlexADC).
[in]	size	buffer size in bytes.
[out]	buffer	returned buffer handle.
[out]	allocated	returned allocated size. The allocated buffer size returned can be greater than the asked size (rounding is done for internal buffer alignment). If NULL is specified for this parameter no value is returned.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqBufferFree(); mxfRxAcqBufferGet(); mxfRxAcqBufferStatusGet()

Examples:: adc.c, adc_buffer_threshold.c, adc_internal_calib.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_trigger.c, ar708_trigger.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bm.c, async.c, async.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_update_embedded.c, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqBufferGet	(	HMXF_HANDLE	handle,
		HMXF_BUFFER *	buffer
	)

C#: public static extern UInt32 mxfRxAcqBufferGet(UInt64 handle, out UInt64 buffer);

Returns the buffer handle allocated to an acquisition channel or module.

Parameters

[in]	handle	channel handle (module handle for FlexADC).
[out]	buffer	returned buffer handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqBufferAlloc()

Examples:: ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ascb_bm.c, mil1553_bm.c, and mil1553_bm.cs.

uint32 mxfRxAcqBufferFree ( HMXF_BUFFER buffer )

C#: public static extern UInt32 mxfRxAcqBufferFree(UInt64 buffer);

Deallocates the memory previously allocated by mxfRxAcqBufferAlloc().

Parameters

[in] buffer buffer handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqBufferAlloc()

Examples:: adc.c, adc_buffer_threshold.c, adc_internal_calib.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_sampling.cs, ar708_trigger.c, ar708_trigger.cs, ar708_tx_error_injection.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bm.c, async.c, async.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_periodic.c, csdb_periodic.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, flexadc.c, flexadc_buffer_threshold.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqBufferStatusGet	(	HMXF_BUFFER	buffer,
		uint64 *	status,
		uint64 *	msgCount,
		uint64 *	pendingBytes,
		uint64 *	freeBytes
	)

C#: public static extern UInt32 mxfRxAcqBufferStatusGet(UInt64 buffer, out UInt64 status, out UInt64 msgCount, out UInt64 pendingBytes, out UInt64 freeBytes);

public static extern UInt32 mxfRxAcqBufferStatusGet(UInt64 buffer, out UInt64 status, IntPtr msgCount, IntPtr pendingBytes, IntPtr freeBytes)
;

Returns the status and the buffer usage statistics (pending data to be read and free bytes) for an acquisition channel.

Parameters

[in] buffer buffer handle

[out]

status

acquisition buffer status

Status	Description
MXF_RXACQ_STATUS_WAIT_START_TIME	acquisition waits for the start time.
MXF_RXACQ_STATUS_WAIT_TRIG	acquisition waits for the trigger.
MXF_RXACQ_STATUS_RUNNING	acquisition is running.
MXF_RXACQ_STATUS_STOPPED	acquisition is stopped.
MXF_RXACQ_STATUS_OVERFLOW	received data was discarded due to full buffer.
MXF_RXACQ_STATUS_BUFFER_FULL	acquisition buffer is full.
MXF_RXACQ_STATUS_RUN_TIMED_OUT	acquisition was stopped after duration.
MXF_RXACQ_STATUS_TRIG_TIMED_OUT	acquisition was stopped after duration while waiting for trigger.
MXF_RXACQ_STATUS_OUT_OF_RESOURCES	acquisition stopped due to full internal buffer.
MXF_RXACQ_STATUS_TRIG_OCCURRED	acquisition trigger occurred.
MXF_RXACQ_STATUS_MODULE_OVERFLOW	module FIFO overflow.

[out] msgCount number of unread messages.

[out] pendingBytes number of unread bytes.

[out] freeBytes number of free bytes.

Note: No value is returned if NULL is specified for the parameters status, mxgCount, pendingBytes, freeBytes.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqBufferAlloc(); mxfRxAcqRead()

Examples:: adc_internal_calib.c, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async.c, async.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqBufferInfoGet	(	HMXF_BUFFER	buffer,
		HMXF_HANDLE *	handle
	)

C#: public static extern UInt32 mxfRxAcqBufferInfoGet(UInt64 buffer, out UInt64 handle);

Returns the channel handle related to an acquisition buffer.

Parameters

[in]	buffer	buffer handle.
[out]	handle	channel or module handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet()

Examples:: adc_buffer_threshold.c.

uint32 mxfRxAcqModeGet	(	HMXF_BUFFER	buffer,
		uint64 *	mode
	)

C#: public static extern UInt32 mxfRxAcqModeGet(UInt64 buffer, out UInt64 mode);

Returns the acquisition mode of the acquisition buffer.

Parameters

[in] buffer buffer handle.

[out]

mode

Acquisition Mode	Description
MXF_RXACQ_MODE_LINEAR	acquisition will stop when the acquisition buffer is full.
MXF_RXACQ_MODE_CIRCULAR	acquisition will continue to run when the acquisition buffer is full and discard the newest received data.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqModeSet()

uint32 mxfRxAcqModeSet	(	HMXF_BUFFER	buffer,
		uint64	mode
	)

C#: public static extern UInt32 mxfRxAcqModeSet(UInt64 buffer, UInt64 mode);

Sets the acquisition mode for the acquisition buffer.

Parameters

[in] buffer buffer handle.

[in]

mode

Acquisition Mode

Description

MXF_RXACQ_MODE_LINEAR

The acquisition process will stop when the acquisition buffer reaches the maximum amount of data for the allocated buffer size. For example, this may occur when an application does not take sufficient time to read an ongoing acquisition. If the application reads data using mxfRxAcqRead(), these data are removed from the acquisition queue, thus freeing space for more data. If so, the acquisition status will remain in the running state indefinitely. mxfRxAcqBufferStatusGet() or mxfRxAcqRead() will return with MXF_RXACQ_STATUS_BUFFER_FULL bit set in the status parameter when no free space is available from the allocated buffer. The acquisition can be restarted with mxfRxAcqStart() function.

MXF_RXACQ_MODE_CIRCULAR

When set, whenever the acquisition buffer becomes full, the acquisition process will discard newest received record. The acquisition status will remain in the running state indefinitely. In this mode, the buffer works like a circular buffer. The function call mxfRxAcqBufferStatusGet() or mxfRxAcqRead() will return with MXF_RXACQ_STATUS_OVERFLOW bit set in the status parameter if any data was discarded. This bit become a sticky bit later on. However, when the acquisition buffer was set in the overflow condition, room for incoming data must be done by either reading or clearing the acquisition buffer. Clearing explicitly the buffer reset the sticky bit. A certain amount of free space (around 4KB) is needed before the acquisition will start receiving new data again.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqModeGet(); mxfRxAcqBufferAlloc()

Examples:: adc_buffer_threshold.c, adc_internal_calib.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_trigger.c, ar708_trigger.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc_buffer_threshold.c, flexdio_sampling_acq.c, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, usb.c, and usb.cs.

uint32 mxfRxAcqMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	options,
		uint64	maxCount,
		uint64 *	count,
		void *	msg
	)

Reads the message ID filter for the acquisition buffer.

Parameters

[in] buffer buffer handle

[in]

options

filtering option

Option	Description
MXF_MSG_SELECT_OPTION_DEFAULT	filter based on the address of the message.
MXF_MSG_SELECT_OPTION_EXTENDED	filter based on the address/extension of the message (MIL1553 only).

[in] maxCount maximum number of messages in the array msg.

[out] count returned number msg in the msg array.

[out]

msg

address of the returned message array.

Channel class	Message identifier structure
ARINC 429	MXF_MSGID_A429
MIL-STD-1553	MXF_MSGID_MIL1553
CSDB	MXF_MSGID_CSDB
ARINC 629	MXF_MSGID_A629
ARINC 708	MXF_MSGID_A708
CAN	MXF_MSGID_CANBUS

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqMsgSelectSet()

uint32 mxfRxAcqMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	options,
		uint64	select,
		uint64	count,
		void *	msg
	)

Selects or deselects the message(s) to be acquired on the specified acquisition buffer.

Upon data arrival, the embedded process will check if the received message is found in the current selection list. The receive data record will be added to the acquisition buffer only if the message is found in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all messages are received.

Parameters

[in] buffer buffer handle.

[in]

options

filtering option

Option	Description
MXF_MSG_SELECT_OPTION_DEFAULT	filter based on the address of the message.
MXF_MSG_SELECT_OPTION_EXTENDED	filter based on the address/extension of the message (MIL1553 only).

[in]

select

action to perform with the message ID array.

Option	Description
MXF_MSG_DESELECT	Deselects the message ID.
MXF_MSG_SELECT_ADD	Adds the specified message ID.
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of msg id in the array.

[in]

msg

address array of message id structure.

Channel class	Message identifier structure
ARINC 429	MXF_MSGID_A429
MIL-STD-1553	MXF_MSGID_MIL1553
CSDB	MXF_MSGID_CSDB
ARINC 629	MXF_MSGID_A629
ARINC 708	MXF_MSGID_A708
CAN	MXF_MSGID_CANBUS

Note: When the count is set to 0 and msg is set to NULL this means all possible message addresses for the protocol. In ARINC 429, the 256 labels are selected implicitly. In MIL1553, all possible RT addresses or RT addresses/subaddresses are selected depending on the MXF_MSG_SELECT_OPTION_EXTENDED option.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqMsgSelectGet()

uint32 mxfRxAcqStart	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	startTime,
		uint64	duration
	)

C#: public static extern UInt32 mxfRxAcqStart(UInt64 buffer, UInt64 flags, UInt64 startTime, UInt64 duration);

Starts the data acquisition process for the specified acquisition buffer. The acquisition starts at the specified starting time and ends after the duration. If mxfRxAcqStart() is called while the acquisition is already running, the contents of the acquisition buffer will be cleared. The acquisition runs until mxfRxAcqStop() is called, a timeout occurs (duration finished) or the acquisition queue becomes full.

Parameters

[in] buffer buffer handle.

[in]

flags

acquisition mode.

Status	Description
MXF_RXACQ_FLAG_DEFAULT	Default. Start time is relative.
MXF_RXACQ_FLAG_ABSOLUTE_START_TIME	Uses absolute start time. This bit flag tells the acquisition process that the start time contains an absolute time at which the acquisition is to be started. Using absolute time, you can synchronize multiple-channel acquisition process to start at the same absolute time.

[in] startTime start time: the time can either represent a relative time (offset in the future) or an absolute time based on the timebase format (absolute time is used when MXF_RXACQ_FLAG_ABSOLUTE_START_TIME is set in the acquisition flag). Relative time are not based on the timebase format but uses the process timebase resolution (microseconds or nanoseconds). A relative time of 0 instructs the acquisition process to start now.

[in] duration duration: the acquisition stops (timeout) after the specified duration. The duration has the same resolution as the timebase format used (microseconds or nanoseconds). Set the duration to zero if you do not want the acquisition process to timeout. The duration is not precise (last at least duration, but can last up to 500 msec more).

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqStop(); mxfRxAcqRead(); mxfSystemTimeBaseSet()

Examples:: adc.c, adc_buffer_threshold.c, adc_internal_calib.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_trigger.c, ar708_trigger.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bm.c, async.c, async.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_update_embedded.c, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqStop ( HMXF_BUFFER buffer )

C#: public static extern UInt32 mxfRxAcqStop(UInt64 buffer);

Stops the acquisition process. After the acquisition is stopped, the data present in the acquisition queue can still be read using mxfRxAcqRead().

Parameters

[in] buffer buffer handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

See also: mxfRxAcqStart(); mxfRxAcqRead()

Examples:: adc.c, adc_buffer_threshold.c, adc_internal_calib.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_embedded_discrete.c, ar429_embedded_discrete.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_UDPCommRxEmbedded.c, ar629_alternate.c, ar629_alternate.cs, ar629_aperiodic_frame.c, ar629_aperiodic_frame.cs, ar629_aperiodic_mode.c, ar629_aperiodic_mode.cs, ar629_block_mode.c, ar629_block_mode.cs, ar629_dual_xpp.c, ar629_dual_xpp.cs, ar629_freshnessCounter_manyCID.c, ar629_freshnessCounter_manyCID.cs, ar629_independent_mode.c, ar629_independent_mode.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_end_system.c, ar664_end_system.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708.c, ar708.cs, ar708_aperiodic.c, ar708_aperiodic.cs, ar708_buffer_threshold.c, ar708_buffer_threshold.cs, ar708_periodic.c, ar708_periodic.cs, ar708_trigger.c, ar708_trigger.cs, ar717.c, ar717.cs, ar717_advance.c, ar717_advance.cs, ar717_buffer_threshold.c, ar717_buffer_threshold.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bm.c, async.c, async.cs, async_flow_control_hw.c, async_flow_control_hw.cs, async_flow_control_sw.c, async_flow_control_sw.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, async_tx_error_injection.c, async_tx_error_injection.cs, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_event_handler.c, discrete_event_handler.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexdio_event_handler.c, flexdio_fifo.c, flexdio_sampling_acq.c, flexdio_sync.c, hdlc.c, hdlc.cs, hdlc_aperiodic.c, hdlc_aperiodic.cs, hdlc_buffer_threshold.c, hdlc_buffer_threshold.cs, hdlc_trigger.c, hdlc_trigger.cs, hdlc_tx_error_injection.c, hdlc_tx_error_injection.cs, hfce.c, hfce_aperiodic.c, hfce_buffer_threshold.c, hfce_trigger.c, hfce_tx_error_injection.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_aperiodic_frame.c, mil1553_aperiodic_frame.cs, mil1553_bc.c, mil1553_bc.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_extclock.c, mil1553_bc_extclock.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm.c, mil1553_bm.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_embedded_async_to_1553.c, mil1553_embedded_update_embedded.c, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, multi.c, multi.cs, usb.c, usb.cs, write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqClose ( HMXF_BUFFER buffer )

C#: public static extern UInt32 mxfRxAcqClose(UInt64 buffer);

Closes the acquisition process. Stops the acquisition, clear and free the acquisition buffer.

Parameters

[in] buffer buffer handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

See also: mxfRxAcqStop(); mxfRxAcqClear(); mxfRxAcqBufferFree()

uint32 mxfRxAcqStopTimeGet	(	HMXF_BUFFER	buffer,
		uint64 *	stopTime
	)

C#: public static extern UInt32 mxfRxAcqStopTimeGet(UInt64 buffer, out UInt64 stopTime);

Returns the time (based on the timebase) at which the acquisition has stopped.

Parameters

[in]	buffer	buffer handle.
[out]	stopTime	stop time.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

See also: mxfSystemTimeBaseSet(); mxfRxAcqStop()

Examples:: ar429_embedded_timer.c, ar429_embedded_timer.cs, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, and ar664_recorder.cs.

uint32 mxfRxAcqClear ( HMXF_BUFFER buffer )

C#: public static extern UInt32 mxfRxAcqClear(UInt64 buffer);

Clears the acquisition buffer.

Parameters

[in] buffer buffer handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

See also: mxfRxAcqBufferAlloc(); mxfRxAcqRead()

Examples:: adc.c, adc_buffer_threshold.c, ar429_aperiodic.c, ar429_aperiodic.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_embedded_comm_queues.c, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_UDPCommRxEmbedded.c, ar664_aperiodicSap.c, ar664_aperiodicSap.cs, ar664_com_queuing_basic.c, ar664_com_queuing_basic.cs, ar664_error_injection_detection.c, ar664_error_injection_detection.cs, ar664_error_injection_detection_ede.c, ar664_error_injection_detection_ede.cs, ar664_playback.c, ar664_playback.cs, ar664_raw_rx.c, ar664_raw_rx.cs, ar664_recorder.c, ar664_recorder.cs, ar708_periodic.c, ar708_periodic.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, ascb_bm.c, async_rx_acquisition_trigger.c, can_fd.c, canbus.c, canbus.cs, canbus_periodic.c, csdb_aperiodic.c, csdb_aperiodic.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_fifo.c, discrete_fifo.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, flexadc.c, flexadc_buffer_threshold.c, flexdio_fifo.c, flexdio_sampling_acq.c, flexdio_sync.c, mil1553_aperiodic.c, mil1553_aperiodic.cs, mil1553_aperiodic_event.c, mil1553_aperiodic_event.cs, mil1553_bc_buserror_trigger.c, mil1553_bc_buserror_trigger.cs, mil1553_bc_dual_major_frame.c, mil1553_bc_dual_major_frame.cs, mil1553_bc_rt_data_assignment.c, mil1553_bc_rt_data_assignment.cs, mil1553_bm_acquisition_trigger.c, mil1553_bm_acquisition_trigger.cs, mil1553_cond_branch_1.c, mil1553_cond_branch_1.cs, mil1553_cond_branch_2.c, mil1553_cond_branch_2.cs, mil1553_ebr.c, mil1553_ebr.cs, mil1553_errors.c, mil1553_errors.cs, mil1553_manyErrorInjections.c, mil1553_manyErrorInjections.cs, mil1553_rt.c, mil1553_rt.cs, mil1553_rt_rt.c, mil1553_rt_rt.cs, mil1553_rtErrorInjections.c, mil1553_rtErrorInjections.cs, usb.c, and usb.cs.

uint32 mxfRxAcqRead	(	HMXF_BUFFER	buffer,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	status,
		uint64 *	msgCount,
		uint64 *	byteCount,
		void *	rec
	)

Generic function to transfer the records from the acquisition buffer to the calling application.

Each channel class has its specific function (example: mxfA629RxAcqRead). For C#, only the specific functions are available.

The time tag in the records is expressed according to the timebase format.

The function reads messages up to maxMsgCount or maxBytesCount, the first one that is reached.

Parameters

[in] buffer buffer handle.

[in] maxMsgCount maximum number of messages to read. Passing 0 to this parameter will make the function ignore it and be only limited by maxBytesCount.

[in] maxBytesCount maximum number of bytes to be read (1 to 100MB).

[out] status last read status: see mxfRxAcqBufferStatusGet() for more details.

[out] msgCount number of records returned.

[out] byteCount number of bytes returned.

[out]

rec

address of data records. The record format depends on the channel class. The records in the buffer need to be indexed using the mxfNextRecordPtrGet() function.

Channel class	Acquisition record structure
ARINC 429	MXF_A429_DATAREC
MIL-STD-1553	MXF_MIL1553_DATAREC
CSDB	MXF_CSDB_DATAREC
ASYNC ENHANCED	MXF_ASYNCEH_DATAREC
ARINC 629	MXF_A629_DATAREC
ARINC 708	MXF_A708_DATAREC
ARINC 717	MXF_A717_DATAREC
HDLC	MXF_HDLC_DATAREC
DISCRETE	MXF_DISCRETE_DATAREC
ARINC 664	MXF_A664_DATAREC
CAN.	MXF_CANBUS_DATAREC
HFCE	MXF_HFCE_DATAREC
Analog	MXF_ANALOG_DATAREC
Flex Analog	MXF_FLEXANALOG_DATAREC
Flex DIO	MXF_FLEXDIO_DATAREC

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqStart(); mxfRxAcqBufferAlloc(); mxfRxAcqStop(); mxfNextRecordPtrGet(); mxfRxAcqBufferStatusGet(); mxfRxAcqReadAsync()

Examples:: ar429_rx_acquisition_trigger.c, ascb_bm.c, csdb_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.c, flexdio_sampling_acq.c, mil1553_bm_acquisition_trigger.c, and multi.c.

uint32 mxfRxAcqReadAsync	(	HMXF_BUFFER	buffer,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		void *	hostBuffer,
		MXF_ASYNCHRONOUS_CALLBACK	readCompletion,
		void *	context
	)

C#: public static extern UInt32 mxfRxAcqReadAsync(UInt64 buffer, UInt64 maxMsgCount, UInt64 maxBytesCount, IntPtr hostBuffer, MXF_ASYNCHRONOUS_CALLBACK readCompletion, IntPtr context);

Transfers asynchronously the records from the channel acquisition buffer to the calling application. The function will return immediately after it has been registered to be executed by another thread. A callback function will be called when the asynchronous function has finished.

A maximum of 1000 asynchronous function calls can be queued.

The time tag in the records is expressed according to the timebase format.

The function reads messages up to maxMsgCount or maxBytesCount, the first one that is reached.

Parameters

[in] buffer buffer handle.

[in] maxMsgCount maximum number of messages to read. Passing 0 to this parameter will make the function ignore it and be only limited by maxBytesCount.

[in] maxBytesCount maximum number of bytes to be read (1 to 100MB).

[out]

hostBuffer

address of data records. The record format depends on the channel class. The records in the buffer need to be indexed using the mxfNextRecordPtrGet() function.

Channel class	Acquisition record structure
ARINC 429	MXF_A429_DATAREC
MIL-STD-1553	MXF_MIL1553_DATAREC
CSDB	MXF_CSDB_DATAREC
ASYNC ENHANCED	MXF_ASYNCEH_DATAREC
ARINC 629	MXF_A629_DATAREC
ARINC 708	MXF_A708_DATAREC
ARINC 717	MXF_A717_DATAREC
HDLC	MXF_HDLC_DATAREC
Discrete	MXF_DISCRETE_DATAREC
ARINC 664	MXF_A664_DATAREC
CAN	MXF_CANBUS_DATAREC
HFCE	MXF_HFCE_DATAREC
Analog	MXF_ANALOG_DATAREC
Flex Analog	MXF_FLEXANALOG_DATAREC
Flex DIO	MXF_FLEXDIO_DATAREC

Note: Except for IPM-DIO-32-FIFO input channels, the first record read after a mxfRxAcqStart() call is the current state of discrete input pins. The following records are generated according to specified discrete input transitions.

Parameters

[in]	readCompletion	callback function to be called when read process has been completed. Callback function is defined as follow: 1 typedef void (MXF_ASYNCHRONOUS_CALLBACK)(HMXF_BUFFER bufferHandle, uint32 result, void context, uint64* output); [in] bufferHandle: buffer handle. [in] result: return code of the function. [in] context: pointer to a value that has been passed for the callback. [in] output: array of additional information. output[0] contains the acquisition status. output[1] contains the number of messages returned in hostBuffer. output[2] contains the number of bytes returned in hostBuffer.
[in]	context	pointer to a value that will be passed to the callback handler (optional).

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqRead()

Examples:: write_read_async.c, and write_read_async.cs.

uint32 mxfRxAcqTrigEnableGet	(	HMXF_BUFFER	buffer,
		uint64 *	state
	)

C#: public static extern UInt32 mxfRxAcqTrigEnableGet(UInt64 buffer, out UInt64 state);

Returns the state of the trigger.

Parameters

[in] buffer buffer handle.

[out]

state

trigger state

Constant	Description
VMXF_ENABLE	Trigger is enabled
VMXF_DISABLE	Trigger is disable

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigEnableSet(); mxfRxAcqTrigSet()

uint32 mxfRxAcqTrigEnableSet	(	HMXF_BUFFER	buffer,
		uint64	state
	)

C#: public static extern UInt32 mxfRxAcqTrigEnableSet(UInt64 buffer, UInt64 state);

Sets the state of the trigger. By default, when a trigger is set with mxfRxAcqTrigSet(), the trigger is enabled. The trigger can be disabled or re-enabled with this function. Disabling a trigger before starting the acquisition will force the acquisition process to ignore the trigger. Disabling a trigger when the acquisition is started and is in wait-trig state will force the acquisition process to switch to running mode (as if the trigger occurred).

Parameters

[in] buffer buffer handle.

[in]

state

trigger state

Constant	Description
VMXF_ENABLE	Enables trigger
VMXF_DISABLE	Disables trigger

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigEnableGet(); mxfRxAcqTrigSet()

uint32 mxfRxAcqTrigSet	(	HMXF_BUFFER	buffer,
		HMXF_COND_LIST	condList,
		uint64	pretrigCount
	)

C#: public static extern UInt32 mxfRxAcqTrigSet(UInt64 buffer, UInt64 condList, UInt64 pretrigCount);

Assigns an acquisition trigger to a buffer. This trigger will take effect after the user has started the acquisition. If a trigger is set, the acquisition will start in the wait-trig state. In this state, the data received is kept in a circular buffer. These data are not available to the application up until the trigger conditions (condList) are evaluated positively or the acquisition is stopped with mxfRxAcqStop(). In this wait-trig state, pretrigCount of data record is kept in the buffer. If the buffer is full, the older data are discarded to make place for newly incoming data. The acquisition buffer size must be of at least two memory segment size (8KB) for the pretrigCount mechanism to work. When the trigger conditions are realized, the acquisition goes into running state. In this state the pre-trig data and all newly incoming data are buffered until the application reads them (through the mxfRxAcqRead() function). In the running state, the application should periodically read the buffered data (mxfRxAcqRead()). If it does not, the buffer may become full, forcing the acquisition process to stop itself.

The acquisition status will be set according to the running or wait-trig state. Please refer to mxfRxAcqBufferStatusGet().

Parameters

[in]	buffer	buffer handle.
[in]	condList	condition list handle.
[in]	pretrigCount	pre-trigger count. Number of records received before the trigger to be kept in the acquisition buffer. This count is not precise, as it can be internally rounded up for performance optimization.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigConditionAdd(); mxfRxAcqTrigConditionListAlloc(); mxfRxAcqStart(); mxfRxAcqRead(); mxfRxAcqBufferStatusGet()

Examples:: ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_bm_acquisition_trigger.c, and mil1553_bm_acquisition_trigger.cs.

uint32 mxfRxAcqTrigTimeGet	(	HMXF_BUFFER	buffer,
		uint64 *	time
	)

C#: public static extern UInt32 mxfRxAcqTrigTimeGet(UInt64 buffer, out UInt64 time);

Returns the acquisition trigger time of the specified acquisition buffer.

Parameters

[in]	buffer	buffer handle.
[out]	time	time of the event triggered based on the timebase.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigSet(); mxfSystemTimeBaseSet()

Examples:: ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_bm_acquisition_trigger.c, and mil1553_bm_acquisition_trigger.cs.

uint32 mxfRxAcqTrigConditionListAlloc	(	HMXF_SERVER	server,
		HMXF_COND_LIST *	condList
	)

C#: public static extern UInt32 mxfRxAcqTrigConditionListAlloc(UInt64 server, out UInt64 condList);

Allocates a condition list for triggering the acquisition on a receive channel.

A condition list is a memory resource that is used to hold one or more conditions defined with mxfRxAcqTrigConditionAdd().

Condition lists are used to define an event that MX Foundation's firmware has to monitor.

The various trigger-related functions take in argument a condition list to specify the trig condition(s).

Parameters

[in]	server	server handle.
[out]	condList	address of condition list HMXF_COND_LIST structure.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigConditionAdd(); mxfRxAcqTrigConditionListFree(); mxfRxAcqTrigSet()

Examples:: ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_bm_acquisition_trigger.c, and mil1553_bm_acquisition_trigger.cs.

uint32 mxfRxAcqTrigConditionListFree ( HMXF_COND_LIST condList )

C#: public static extern UInt32 mxfRxAcqTrigConditionListFree(UInt64 condList);

Frees a condition list defined for triggering acquisition.

Parameters

[in] condList condition list handle.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigConditionListAlloc()

Examples:: ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_bm_acquisition_trigger.c, and mil1553_bm_acquisition_trigger.cs.

uint32 mxfRxAcqTrigConditionListExprSet	(	HMXF_COND_LIST	condList,
		uint64	expression
	)

C#: public static extern UInt32 mxfRxAcqTrigConditionListExprSet(UInt64 condList, UInt64 expression);

Assigns an expression to the specified condition list when more than one condition is defined.

The expression represents the link between conditions. Two expressions are defined: “AND” and “OR”.

Parameters

[in] condList condition list handle.

[in]

expression

expression.

Expression	Description
MXF_RXACQ_TRIG_COND_EXPR_AND	In order for the condition list to be true, all conditions must be evaluated as TRUE
MXF_RXACQ_TRIG_COND_EXPR_OR	Only one condition evaluated to be TRUE will make the condition list TRUE

Note: The default value is "OR".

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigConditionAdd(); mxfRxAcqTrigConditionListAlloc()

uint32 mxfRxAcqTrigConditionAdd	(	HMXF_COND_LIST	condList,
		uint64	id,
		void *	param
	)

C#: public static extern UInt32 mxfRxAcqTrigConditionAdd(UInt64 condList, UInt64 id, ref MXF_RXACQ_TRIG_COND_ACQRUN_PARM param);

public static extern UInt32 mxfRxAcqTrigConditionAdd(UInt64 condList, UInt64 id, ref MXF_RXACQ_TRIG_COND_RDATA_DW_PARM param);

Adds a condition to the condition list for triggering acquisition.

A condition specifies the event to be monitored for a trigger action.

When a list holds multiple conditions, they are either ORed or ANDed in the evaluation of the condition list (see mxfRxAcqTrigConditionListExprSet()).

Parameters

[in] condList condition list.

[in]

id

condition identifier.

Condition	Description
MXF_RXACQ_TRIG_COND_ID_ACQRUN	Checks if specified channels are in the running state. Used with the MXF_RXACQ_TRIG_COND_ACQRUN_PARM structure.
MXF_RXACQ_TRIG_COND_ID_RDATA_DW	Checks the received data against the user mask and value (uint32 comparison). Used with the MXF_RXACQ_TRIG_COND_RDATA_DW_PARM structure.

[in] param condition definition (structure) based on the id parameter.

Note: A maximum of four conditions can be added to a condition list.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqTrigConditionListAlloc(); mxfRxAcqTrigConditionListExprSet()

Examples:: ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar708_trigger.c, ar708_trigger.cs, ar717_rx_acquisition_trigger.c, ar717_rx_acquisition_trigger.cs, async_rx_acquisition_trigger.c, async_rx_acquisition_trigger.cs, csdb_rx_acquisition_trigger.c, csdb_rx_acquisition_trigger.cs, discrete_rx_acquisition_trigger.c, discrete_rx_acquisition_trigger.cs, hdlc_trigger.c, hdlc_trigger.cs, hfce_trigger.c, mil1553_bm_acquisition_trigger.c, and mil1553_bm_acquisition_trigger.cs.

uint32 mxfRxAcqBufferAsyncEventInit	(	HMXF_BUFFER	buffer,
		uint64	almostFull,
		void *	context,
		MXF_ASYNCEVENT_BUFFER_HANDLER	callback
	)

C#: public static extern UInt32 mxfRxAcqTrigConditionListExprSet(UInt64 condList, UInt64 expression);

Sets an async event handler for a Rx acquisition buffer. When the almost full threshold will be reached, the callback will be called once and will be called again only when the almost full threshold will be reached again.

Parameters

[in]	buffer	Rx acquisition buffer handle
[in]	almostFull	almost full threshold value
[in]	context	handler callback context
[in]	callback	Rx acquisition buffer callback handler

The callback handler function is defined as follow:

1 typedef uint32 (*MXF_ASYNCEVENT_BUFFER_HANDLER)(HMXF_BUFFER buffer, void* context);

[in] buffer: buffer handle [in] context: context pointer

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxAcqBufferAsyncEventTerminate(); mxfAsyncEventConditionsSet()

uint32 mxfRxAcqBufferAsyncEventTerminate ( HMXF_BUFFER buffer )

C#: public static extern UInt32 mxfRxAcqBufferAsyncEventTerminate(UInt64 buffer);

Clears the async event handler for a Rx acquisition buffer.

Parameters

[in] buffer Rx acquisition buffer handle

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxAcqBufferAsyncEventInit(); mxfAsyncEventConditionsSet()

uint32 mxfRxMsgChannelAsyncEventInit	(	HMXF_CHANNEL	channel,
		void *	context,
		MXF_ASYNCEVENT_RXMSG_HANDLER	callback
	)

C#: public static extern mxfRxMsgChannelAsyncEventInit(UInt64 channel, IntPtr context, MXF_ASYNCEVENT_RXMSG_HANDLER callback);

Sets an async event handler for a Rx Msg. When the message will be received, the callback will be called once and will be called again only when the message will be received again. The messages are selected with mxfRxMsgAsyncEventMsgSelectSet().

Parameters

[in]	channel	Rx channel handle
[in]	context	handler callback context
[in]	callback	Rx Msg callback handler

The callback handler function is defined as follow:

1 typedef uint32 (*MXF_ASYNCEVENT_RXMSG_HANDLER)(HMXF_CHANNEL channel, void* msg, void* context);

[in] buffer: buffer handle [in] msg: pointer to message (MXF_MSGID structure depending on the channel class) [in] context: context pointer

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxMsgChannelAsyncEventTerminate(); mxfAsyncEventConditionsSet()

uint32 mxfRxMsgChannelAsyncEventTerminate ( HMXF_CHANNEL channel )

C#: public static extern mxfRxMsgChannelAsyncEventTerminate(UInt64 channel);

Clears the async event handler for a Rx Msg.

Parameters

[in] channel Rx channel handle

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxMsgChannelAsyncEventInit(); mxfAsyncEventConditionsSet()

uint32 mxfRxMsgAsyncEventMsgSelectSet	(	HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		void *	msg
	)

Selects or deselects the message IDs for Rx Msg condition on a specified RX channel.

This function must be called in addition to mxfRxMsgChannelAsyncEventInit() to cause an asynchronous event to occur when a specific message ID is received.

Note: count set to 0 with a msg set to NULL means ALL message IDs.

Parameters

[in] channel channel handle

[in]

select

action to perform for the message IDs

Action	Description
MXF_MSG_DESELECT	Deselects the message IDs
MXF_MSG_SELECT_ADD	Adds the specified message IDs
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list

[in] count count of messages IDs

[in]

msg

array of message IDs.

Channel class	Message identifier structure
ARINC 429	MXF_MSGID_A429
MIL-STD-1553	MXF_MSGID_MIL1553
CSDB	MXF_MSGID_CSDB
ARINC 629	MXF_MSGID_A629
ARINC 708	MXF_MSGID_A708
CAN	MXF_MSGID_CANBUS

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxMsgAsyncEventMsgSelectGet(); mxfAsyncEventConditionsSet()

uint32 mxfRxMsgAsyncEventMsgSelectGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		void *	msg
	)

Returns the list of message IDs registered for a specified RX channel for Rx Msg asynchronous event condition ID.

Parameters

[in]	channel	channel handle
[in]	maxCount	maximum message IDs expected
[out]	count	number of message IDs returned
[out]	msg	returned message IDs array

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxMsgAsyncEventMsgSelectSet(); mxfAsyncEventConditionsSet()

uint32 mxfRxErrChannelAsyncEventInit	(	HMXF_CHANNEL	channel,
		void *	context,
		MXF_ASYNCEVENT_RXERR_HANDLER	callback
	)

C#: public static extern mxfRxErrChannelAsyncEventInit(UInt64 channel, IntPtr context, MXF_ASYNCEVENT_RXERR_HANDLER callback);

Sets an async event handler for a Rx Error. When an received error will be detected, the callback will be called once and will be called again only when another received error will be detected.

Parameters

[in]	channel	Rx channel handle
[in]	context	handler callback context
[in]	callback	Rx Err buffer callback handler

The callback handler function is defined as follow:

1 typedef uint32 (*MXF_ASYNCEVENT_RXERR_HANDLER)(HMXF_CHANNEL channel, uint64 status, void* msg, void* context);

[in] channel: channel handle [in] status: detected error [in] msg: pointer to message (MXF_MSGID structure depending on the channel class) [in] context: context pointer

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxErrChannelAsyncEventTerminate(); mxfAsyncEventConditionsSet()

uint32 mxfRxErrChannelAsyncEventTerminate ( HMXF_CHANNEL channel )

C#: public static extern mxfRxErrChannelAsyncEventTerminate(UInt64 channel);

Clears the async event handler for a Rx Error.

Parameters

[in] channel Rx channel handle

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.3.1 and later.

See also: mxfRxErrChannelAsyncEventInit(); mxfAsyncEventConditionsSet()

Functions

Detailed Description

Function Documentation