API Functions Reference
	RX-TO-TX Bridge

Functions
uint32	mxfA429ArwCompose (uint64 label, uint64 sdi, uint64 data, uint64 ssm, uint64 parity, uint32 *arincw)

uint32	mxfA429ArwDecompose (uint32 arincw, uint64 label, uint64 sdi, uint64 data, uint64 ssm, uint64 *parity)

uint32	mxfA429ArwCompose25bit (uint64 label, uint64 data, uint64 parity, uint32 *arincw)

uint32	mxfA429ArwDecompose25bit (uint32 arincw, uint64 label, uint64 data, uint64 *parity)

uint32	mxfA429ArwBnrToReal (uint32 arincw, double range, uint64 sbits, double *real)

uint32	mxfA429ArwRealToBnr (double range, uint64 sbits, double real, uint32 arincw)

uint32	mxfA429ArwCompose2 (uint64 label, uint64 sdi, uint64 data, uint64 parity, uint32 *arincw)

uint32	mxfA429ArwDecompose2 (uint32 arincw, uint64 label, uint64 sdi, uint64 data, uint64 parity)

uint32	mxfA429ArwCompose3 (uint64 label, uint64 data, uint64 parity, uint32 *arincw)

uint32	mxfA429ArwDecompose3 (uint32 arincw, uint64 label, uint64 data, uint64 *parity)

uint32	mxfA429TxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_A429_DATAREC *rec)

uint32	mxfA429TxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_A429_DATAREC *rec)

uint32	mxfA429RxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA429RxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)

uint32	mxfA429RxAcqRead (HMXF_BUFFER buffer, uint64 maxRecCount, uint64 maxBytesCount, uint64 status, uint64 recCount, uint64 bytesCount, MXF_A429_DATAREC rec)

uint32	mxfA429RxSamplingExtEnableSet (HMXF_BUFFER buffer, uint64 state, uint64 count, uint64 *labels)

uint32	mxfA429RxSamplingExtEnableAllGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA429RxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)

uint32	mxfA429RxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfA429RxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_A429_SAMPREC *rec)

uint32	mxfA429RxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 label, uint64 sdi, MXF_A429_SAMPREC *rec)

uint32	mxfA429NextDataRecordPtrGet (MXF_A429_DATAREC currentRec, MXF_A429_DATAREC *nextRec)

uint32	mxfA429NextSamplingRecordPtrGet (MXF_A429_SAMPREC currentRec, MXF_A429_SAMPREC *nextRec)

uint32	mxfA429AsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_A429 *msg)

uint32	mxfA429AsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_A429 msg)

uint32	mxfA429EmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_A429 *msgid)

uint32	mxfA429EmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_A429 msgid)

uint32	mxfA429EmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_A429_DATAREC *msg)

uint32	mxfA429EmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, MXF_A429_DATAREC msg, uint64 count)

uint32	mxfA429ParametricTxVoltage (HMXF_CHANNEL channel, double voltage, uint64 load)

Detailed Description

Function Documentation

uint32 mxfA429ArwCompose	(	uint64	label,
		uint64	sdi,
		uint64	data,
		uint64	ssm,
		uint64	parity,
		uint32 *	arincw
	)

C#: public static extern UInt32 mxfA429ArwCompose(UInt64 label, UInt64 sdi, UInt64 data, UInt64 ssm, UInt64 parity, out UInt32 arincw);

Builds a 32-bit ARINC word from its fields.

The format of the 32-bit word is;

 PSS                   SS
 ASS-------data--------DD-label--
 RMM                   II
 33322222222221111111111000000000
 21098765432109876543210987654321

Note: See the section ARINC 429 word for more information about the meaning of the bits fields.

Parameters

[in] label label (0-255)[bits 1-8].

[in] sdi sdi (0-3)[bits 9-10].

[in] data data (0-0x7FFFF)[bits 11-29].

[in] ssm ssm (0-3)[bits 30-31].

[in]

parity

parity [bit 32]

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.
VMXF_A429_PARITY_NONE	Does not compute parity.

[out] arincw ARINC word 32-bit value.

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: mxfA429ArwDecompose(); mxfA429ArwDecompose2(); mxfA429ArwDecompose3()

Examples:: 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_recorder.c, ar429_embedded_recorder.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_acquisition_trigger.c, ar429_rx_acquisition_trigger.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, ar429_UDPCommRxEmbedded.c, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, multi.c, multi.cs, usb.c, and usb.cs.

uint32 mxfA429ArwDecompose	(	uint32	arincw,
		uint64 *	label,
		uint64 *	sdi,
		uint64 *	data,
		uint64 *	ssm,
		uint64 *	parity
	)

C#: public static extern UInt32 mxfA429ArwDecompose(UInt32 arincw, out UInt64 label, out UInt64 sdi, out UInt64 data, out UInt64 ssm, out UInt64 parity);

Extracts the fields from a 32-bit ARINC word.

The format of the word is:

 PSS                   SS
 ASS-------data--------DD-label--
 RMM                   II
 33322222222221111111111000000000
 21098765432109876543210987654321

Note: See the section ARINC 429 word for more information about the meaning of the bits fields.

Parameters

[in] arincw ARINC word 32-bit value.

[out] label label (bits 1-8).

[out] sdi sdi (bits 9-10).

[out] data data (bits 11-29).

[out] ssm ssm (bits 30-31).

[out]

parity

parity (bit 32).

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.

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: mxfA429ArwCompose(); mxfA429ArwDecompose2(); mxfA429ArwDecompose3()

Examples:: 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_recorder.c, ar429_embedded_recorder.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_rx_sampling.c, ar429_rx_sampling.cs, ar429_UDPCommRxEmbedded.c, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, usb.c, and usb.cs.

uint32 mxfA429ArwCompose25bit	(	uint64	label,
		uint64	data,
		uint64	parity,
		uint32 *	arincw
	)

C#: public static extern UInt32 mxfA429ArwCompose25bit(UInt64 label, UInt64 data, UInt64 parity, out UInt32 arincw);

Builds a 25-bit ARINC word from its fields.

The format of the word is:

 P                     
 A------data-----|-label--
 R                     
 2222221111111111000000000
 5432109876543210987654321

The bits 32-26 in the output word are not used.

Note: See the section ARINC 429 word 25-bit for more information.

Parameters

[in] label label (0-255)[bits 1-8].

[in] data data word (0-0xFFFF)[bits 9-24].

[in]

parity

parity [bit 25].

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.
VMXF_A429_PARITY_NONE	Does not compute parity.

[out] arincw 25-bit value.

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: mxfA429ArwDecompose25bit()

uint32 mxfA429ArwDecompose25bit	(	uint32	arincw,
		uint64 *	label,
		uint64 *	data,
		uint64 *	parity
	)

C#: public static extern UInt32 mxfA429ArwDecompose25bit(UInt32 arincw, out UInt64 label, out UInt64 data, out UInt64 parity);

Extracts the fields from a 25-bit ARINC word.

The format of the word is:

 P                     
 A------data----|--label--
 R                     
 2222221111111111000000000
 5432109876543210987654321

The bits 32-26 in the output word are not used.

Note: See the section ARINC 429 word 25-bit for more information.

Parameters

[in] arincw arinc word.

[out] label label (bits 1-8).

[out] data data word (bits 9-24).

[out]

parity

parity (bit 25).

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.

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: mxfA429ArwCompose25bit()

uint32 mxfA429ArwBnrToReal	(	uint32	arincw,
		double	range,
		uint64	sbits,
		double *	real
	)

C#: public static extern UInt32 mxfA429ArwBnrToReal(UInt32 arincw, Double range, UInt64 sbits, out Double real);

Extracts the BNR value from the ARINC word.

Note: See the section ARINC 429 word for more information.

Parameters

[in]	arincw	32-bit value.
[in]	range	maximum range.
[in]	sbits	number of significant bits.
[out]	real	real value returned.

Returns: MAXT_ERROR_NULLPTR
MAXT_ERROR_PARAM 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: mxfA429ArwRealToBnr()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_bridge_from_ar429.c, and ar717_bridge_from_ar429.cs.

uint32 mxfA429ArwRealToBnr	(	double	range,
		uint64	sbits,
		double *	real,
		uint32 *	arincw
	)

C#: public static extern UInt32 mxfA429ArwRealToBnr(Double range, UInt64 sbits, ref double real, out UInt32 arincw);

Sets the BNR value of a specified ARINC word.

Note: See the section ARINC 429 word for more information.

Parameters

[in]	range	maximum range.
[in]	sbits	number of significant bits.
[in]	real	real value to convert to BNR. Rounded value set in the arincw is returned.
[out]	arincw	ARINC word 32-bit value.

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: mxfA429ArwBnrToReal()

Examples:: ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar717_bridge_from_ar429.c, and ar717_bridge_from_ar429.cs.

uint32 mxfA429ArwCompose2	(	uint64	label,
		uint64	sdi,
		uint64	data,
		uint64	parity,
		uint32 *	arincw
	)

C#: public static extern UInt32 mxfA429ArwCompose2(UInt64 label, UInt64 sdi, UInt64 data, UInt64 parity, out UInt32 arincw);

Builds a 32-bit ARINC word without the SSM field.

Note: This function differs from mxfA429ArwCompose() because the SSM field is not used.

The encapsulation format is as follows:

 P                     SS
 A---------data--------DD-label--
 R                     II
 33322222222221111111111000000000
 21098765432109876543210987654321

For this specific format, the parameter data covers the SSM bits (31-30) of the word.

Note: See the section ARINC 429 word for more information.

Parameters

[in] label label (0-255)[bits 1-8].

[in] sdi sdi (0-3)[bits 9-10].

[in] data data (0-0x1FFFFF)[bits 11-31].

[in]

parity

parity [bit 32]

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.
VMXF_A429_PARITY_NONE	Does not compute parity.

[out] arincw ARINC word 32-bit value.

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: mxfA429ArwDecompose2(); mxfA429ArwCompose(); mxfA429ArwCompose3()

uint32 mxfA429ArwDecompose2	(	uint32	arincw,
		uint64 *	label,
		uint64 *	sdi,
		uint64 *	data,
		uint64 *	parity
	)

C#: public static extern UInt32 mxfA429ArwDecompose2(UInt32 arincw, out UInt64 label, out UInt64 sdi, out UInt64 data, out UInt64 parity);

Extracts the fields without SSM from a 32-bit ARINC word.

Note: This function differs from mxfA429ArwDecompose() because the SSM fields is not used.

The input ARINC word format is as follow;

 P                     SS
 A---------data--------DD-label--
 R                     II
 33322222222221111111111000000000
 21098765432109876543210987654321

For this specific format the parameter data cover the SSM bits (31-30) of the word.

Note: See the section ARINC 429 word for more information.

Parameters

[in] arincw arinc word 32-bit value.

[out] label label (bits 1-8).

[out] sdi sdi (bits 9-10).

[out] data data (bits 11-31).

[out]

parity

parity (bit 32).

Constant	Meaning
VMXF_A429_PARITY_ODD	Odd parity.
VMXF_A429_PARITY_EVEN	Even parity.

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: mxfA429ArwCompose2(); mxfA429ArwDecompose(); mxfA429ArwDecompose3()

uint32 mxfA429ArwCompose3	(	uint64	label,
		uint64	data,
		uint64	parity,
		uint32 *	arincw
	)

C#: public static extern UInt32 mxfA429ArwCompose3(UInt64 label, UInt64 data, UInt64 parity, out UInt32 arincw);

Builds a 32-bit ARINC word without the SSM and SDI fields.

Note: This function differs from mxfA429ArwCompose() because the SSM and SDI fields are not used.

The encapsulation format is as follow;

 P                      |
 A---------data---------|-label--
 R                      |
 33322222222221111111111000000000
 21098765432109876543210987654321

For this specific format, the parameter data covers the SSM bits (31-30) and SDI bits (9-10) of the word.

Note: See the section ARINC 429 word for more information.

Parameters

[in]	label	label (0-255)[bits 1-8].
[in]	data	data (0-0x7FFFFF)[bits 9-31].
[in]	parity	parity [bit 32] VMXF_A429_PARITY_ODD: Odd parity. VMXF_A429_PARITY_EVEN: Even parity.

VMXF_A429_PARITY_NONE: Does not compute parity.
Parameters

[out] arincw ARINC word 32-bit value.

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
mxfA429ArwDecompose3()

mxfA429ArwCompose()

mxfA429ArwCompose2()

uint32 mxfA429ArwDecompose3	(	uint32	arincw,
		uint64 *	label,
		uint64 *	data,
		uint64 *	parity
	)

C#: public static extern UInt32 mxfA429ArwDecompose3(UInt32 arincw, out UInt64 label, out UInt64 data, out UInt64 parity);

Extracts the fields without SSM and SDI from a 32-bit ARINC word.

Note: For this specific format, the parameter data cover the SSM bits (31-30) and SDI bits (9-10) of the word.

The input ARINC word format is as follow;

 P                      |
 A---------data---------|-label--
 R                      |
 33322222222221111111111000000000
 21098765432109876543210987654321

For this specific format, the parameter data covers the SSM bits (31-30) and SDI bits (9-10) of the word.

Note: See the section ARINC 429 word for more information.

Parameters

[in]	arincw	arinc word 32-bit value.
[out]	label	label (bits 1-8).
[out]	data	data (bits 9-31).
[out]	parity	parity (bit 32). VMXF_A429_PARITY_ODD: Odd parity. VMXF_A429_PARITY_EVEN: Even parity.

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: mxfA429ArwCompose3(); mxfA429ArwDecompose(); mxfA429ArwDecompose2()

uint32 mxfA429TxAperiodicWrite	(	HMXF_BUFFER	buffer,
		uint64	options,
		uint64	startTime,
		uint64	count,
		MXF_A429_DATAREC *	rec
	)

C#: public static extern UInt32 mxfA429TxAperiodicWrite(UInt64 buffer, UInt64 options, UInt64 startTime, UInt64 count, IntPtr rec);

Sends aperiodic data records for transmission. The data items to be transmitted are specified within the records, along with a time tag and a control word. The first data item is transmitted at the specified start time.

The records to transmit on time tag must be placed in chronological order in the array. The same time tag must not appear more than once in the array. When the start time is specified, the time tag of the first record or the start time should be at least 50 msec in advance to be relatively precise, otherwise it will be sent as soon as possible. Also, the cumulative time of all record’s time tag and the start time must be smaller than 30 seconds.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfTxAperiodicWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	options	options for controlling the transmitter before for sending the data records. The details of the options are explained below. MXF_TXAPERIODIC_FLAG_DEFAULT MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME
[in]	startTime	start time based on the timebase. This is the time at which the data held in the first record is transmitted by the device. The time is either expressed accordingly to the process time base or relative to the current real-time clock value (i.e. offset in the future). If the bit MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME of the transmit flag is set, then the start time is specified in absolute time (rather than relative). MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options cannot be used with a start time.
[in]	count	number of records to write
[in]	rec	records to write. The records in the buffer need to be indexed using the mxfA429NextDataRecordPtrGet() function.

The options parameter modifies the transmission scheme as described below;

MXF_TXAPERIODIC_FLAG_DEFAULT

This is the default transmission flag, the scheduling priority defined when the buffer area was defined (see mxfTxAperiodicBufferAlloc()) is used to schedule transmissions.

The time tag field is not used and must be set to 0. The records are transmitted with minimum delay between them.
MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME

When set, the absolute transmit time of each data must be set in the record time tag. The time tag must be formatted according to the process time base.

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.
MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME

When set, the relative transmit time of each data must be set in the record time tag. The process time base resolution is used, but the time base itself is ignored.

This option causes transmission of the first record at the specified offset and transmission of the remaining records after a delay that is computed by subtracting the record time tag from the time tag of preceding records (i.e. delta time).

Let’s assume N data records to be transmitted with the MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME.

The actual record data transmit time will be computed as follows:

Time rec1 = Transmission offset (min 50 msec)
Time rec2 = Time rec1 + (rec2 time tag – rec1 time tag )
Time rec3 = Time rec2 + (rec3 time tag – rec2 time tag )
…
Time recN = Time recN-1 + (recN time tag - recN-1 time tag )

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.
MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME

When set, the startTime parameter must be formatted according to the process time base.

If not set, the startTime parameter is expressed as a relative time from the current real time clock value. The process time base resolution is used, but the time base itself is ignored.

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options.

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: mxfTxAperiodicWrite(); mxfTxAperiodicBufferAlloc(); mxfTxAperiodicBufferStatusGet(); mxfTxAperiodicClear(); mxfSystemTimeBaseSet(); mxfA429NextDataRecordPtrGet()

Examples:: ar429_aperiodic.c, ar429_aperiodic.cs, ar429_embedded_bridge.c, ar429_embedded_bridge.cs, ar429_UDPCommRxEmbedded.c, ar717_bridge_from_ar429.c, and ar717_bridge_from_ar429.cs.

uint32 mxfA429TxPeriodicUpdateMsgWrite	(	HMXF_BUFFER	buffer,
		uint64	count,
		MXF_A429_DATAREC *	rec
	)

C#: public static extern UInt32 mxfA429TxPeriodicUpdateMsgWrite(UInt64 buffer, UInt64 count, IntPtr rec);

Writes messages of the record array into the specified buffer. The last message of each buffer is sent forever until a new message is written into the buffer.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfTxPeriodicUpdateMsgWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	count	count of records to write.
[in]	rec	array of record(s) to write. The records in the buffer need to be indexed using mxfA429NextDataRecordPtrGet() function.

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: mxfTxPeriodicUpdateMsgWrite(); mxfTxPeriodicUpdateMsgBufferStatusGet(); mxfTxPeriodicUpdateMsgClear(); mxfA429NextDataRecordPtrGet()

Examples:: ar429_buffer_threshold.c, ar429_buffer_threshold.cs, ar429_embedded_comm_queues.c, ar429_embedded_recorder.c, ar429_embedded_recorder.cs, ar429_periodic.c, ar429_periodic.cs, ar429_rx_event_handler.c, ar429_rx_event_handler.cs, ar429_rx_sampling.c, ar429_rx_sampling.cs, usb.c, and usb.cs.

uint32 mxfA429RxAcqMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxAcqMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels selected for acquisition.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxAcqMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array.
[out]	count	returned number of labels in the label array.
[out]	labels	address of the returned label 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.0 and later.

See also: mxfRxAcqMsgSelectGet(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfA429RxAcqMsgSelectSet()

uint32 mxfA429RxAcqMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA429RxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

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

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

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

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for ARINC 429 of the multi-protocol mxfRxAcqMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the labels array.

Option	Description
MXF_MSG_DESELECT	Deselects the label(s).
MXF_MSG_SELECT_ADD	Adds the specified label(s).
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count number of entries in labels.

[in] labels address of array of labels

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(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfA429RxAcqMsgSelectGet()

Examples:: ar429_buffer_threshold.c, and ar429_buffer_threshold.cs.

uint32 mxfA429RxAcqRead	(	HMXF_BUFFER	buffer,
		uint64	maxRecCount,
		uint64	maxBytesCount,
		uint64 *	status,
		uint64 *	recCount,
		uint64 *	bytesCount,
		MXF_A429_DATAREC *	rec
	)

C#: public static extern UInt32 mxfA429RxAcqRead(UInt64 buffer, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Transfers the records from the channel acquisition buffer to the calling application.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxAcqRead() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxRecCount	maximum records to read (0 means all messages).
[in]	maxBytesCount	maximum number of bytes to be read.
[out]	status	last status set.
[out]	recCount	number of records returned.
[out]	bytesCount	number of bytes returned.
[out]	rec	address of data records. The records in the buffer need to be indexed using the mxfA429NextDataRecordPtrGet() function.

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(); mxfRxAcqStart(); mxfRxAcqBufferAlloc(); mxfRxAcqStop(); mxfA429NextDataRecordPtrGet()

Examples:: 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.cs, ar429_UDPCommRxEmbedded.c, ar708_buffer_threshold.cs, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, usb.c, and usb.cs.

uint32 mxfA429RxSamplingExtEnableSet	(	HMXF_BUFFER	buffer,
		uint64	state,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, UInt64[] labels);

Enables or disables message discrimination using the SDI. The message look-up table will have entry for each message Label-SDI pair.

By default, after a device reset, message discrimination using the SDI is disabled.

Note: count set to 0 with labels set to NULL means ALL label-sdi.; This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingExtEnableSet() function.

Parameters

[in] buffer buffer handle.

[in]

state

message address extension discrimination state.

Constant	Meaning
VMXF_ENABLE	Enables message address extension discrimination.
VMXF_DISABLE	Disables message address extension discrimination.

[in] count number of entries in labels.

[in] labels address of array of labels.

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: mxfRxSamplingExtEnableSet(); mxfA429RxSamplingExtEnableAllGet()

uint32 mxfA429RxSamplingExtEnableAllGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxSamplingExtEnableAllGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels that has message discrimination using the SDI enabled.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingExtEnableAllGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of entries in labels.
[out]	count	number of entries in labels.
[out]	labels	address array of labels.

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: mxfRxSamplingExtEnableAllGet(); mxfA429RxSamplingExtEnableSet()

uint32 mxfA429RxSamplingMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfA429RxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

Selects or deselects the label(s) to be received on the specified sampling buffer.

Upon data arrival, the embedded process checks if the received label is defined in the current selection list. The receive data record will be added to the sampling buffer only if the label was added previously in the selection list, otherwise it is discarded.

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

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the message ID array.

Option	Description
MXF_MSG_DESELECT	Deselects the label(s).
MXF_MSG_SELECT_ADD	Adds the specified label(s).
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of labels in the array.

[in] labels address of array of label(s).

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: mxfRxSamplingMsgSelectSet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfA429RxSamplingRead(); mxfA429RxSamplingMsgSelectGet()

Examples:: ar429_rx_sampling.c, and ar429_rx_sampling.cs.

uint32 mxfA429RxSamplingMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfA429RxSamplingMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels selected for sampling.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array labels.
[out]	count	returned number of labels in the labels array.
[out]	labels	address of the returned labels 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.0 and later.

See also: mxfRxSamplingMsgSelectGet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfA429RxSamplingRead(); mxfA429RxSamplingMsgSelectSet()

uint32 mxfA429RxSamplingRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_A429_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfA429RxSamplingRead(UInt64 buffer, UInt64 flags, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 byteCount, IntPtr rec);

Reads all sampling records from the sampling buffer to the application buffer.

The sampling process maintains records for all of the received labels. A label is considered received if corresponding data words were received within the kill-time period. A record refresh from the receive port resets the kill-time timer and an updated copy is made available to the application.

The sampling record contains information on the arrival rate and the number of errors, as well as the latest data received for that label.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] maxMsgCount maximum number of messages to read (0 means all messages).

[in] maxBytesCount maximum number of bytes to read.

[out] msgCount number of messages returned.

[out] byteCount number of bytes returned.

[out] rec array of sampling record structure. The records in the buffer need to be indexed using mxfA429NextSamplingRecordPtrGet().

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: mxfRxSamplingRead(); mxfRxSamplingBufferAlloc(); mxfA429RxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfA429NextSamplingRecordPtrGet()

Examples:: ar429_rx_sampling.c, and ar429_rx_sampling.cs.

uint32 mxfA429RxSamplingSingleRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	label,
		uint64	sdi,
		MXF_A429_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfA429RxSamplingSingleRead(UInt64 buffer, UInt64 flags, UInt64 label, UInt64 sdi, IntPtr rec);

Reads a specific sampling record from the sampling buffer.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfRxSamplingSingleRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] label message label.

[in] sdi message sdi.

[out] rec address of sampling record.

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: mxfRxSamplingSingleRead(); mxfRxSamplingBufferAlloc(); mxfRxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfRxSamplingStop()

Examples:: ar429_rx_event_handler.c, and ar429_rx_event_handler.cs.

uint32 mxfA429NextDataRecordPtrGet	(	MXF_A429_DATAREC *	currentRec,
		MXF_A429_DATAREC **	nextRec
	)

C#: public static extern UInt32 mxfA429NextDataRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A429_DATAREC buffer array.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the buffer.

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: mxfNextRecordPtrGet(); mxfA429RxAcqRead(); mxfA429TxAperiodicWrite(); mxfA429TxPeriodicUpdateMsgWrite(); mxfA429NextSamplingRecordPtrGet()

Examples:: 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_recorder.c, ar429_embedded_recorder.cs, ar429_embedded_timer.c, ar429_embedded_timer.cs, ar429_periodic.c, ar429_periodic.cs, ar429_UDPCommRxEmbedded.c, ar717_bridge_from_ar429.c, ar717_bridge_from_ar429.cs, multi.c, multi.cs, usb.c, and usb.cs.

uint32 mxfA429NextSamplingRecordPtrGet	(	MXF_A429_SAMPREC *	currentRec,
		MXF_A429_SAMPREC **	nextRec
	)

C#: public static extern UInt32 mxfA429NextSamplingRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_A429_SAMPREC buffer array.

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the buffer.

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: mxfNextRecordPtrGet(); mxfA429RxSamplingRead(); mxfA429NextDataRecordPtrGet()

Examples:: ar429_rx_sampling.c, and ar429_rx_sampling.cs.

uint32 mxfA429AsyncEventRxMsgSelectSet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		MXF_MSGID_A429 *	msg
	)

C#: public static extern UInt32 mxfA429AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_A429[] msg);

public static extern UInt32 mxfA429AsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, IntPtr msg);

Selects or deselects the label-sdi pair (message id) for MXF_ASYNCEVENT_COND_RX_MSG condition on a specified RX channel.

The function must be called in addition to the mxfAsyncEventConditionsSet() function with MXF_ASYNCEVENT_COND_RX_MSG condition to cause an asynchronous event to occur when a specific label-sdi is received.

The message selection must be made by only one asynchronous event routine for a specific channel. Otherwise, an error code will be returned while conditions of other asynchronous event routines are present.

In this case, you must disable the MXF_ASYNCEVENT_COND_RX_MSG condition using mxfAsyncEventConditionsSet() function using another asynchronous event handle.

Note: count set to 0 with msg set to NULL means ALL label-sdi.; This function is the specific version for ARINC 429 of the multi-protocol mxfAsyncEventRxMsgSelectSet() function.

Parameters

[in] asyncEvent asynchronous event handle.

[in] channel channel handle.

[in]

select

action to perform for the message ID.

Action	Description
MXF_MSG_DESELECT	Deselects the messages id.
MXF_MSG_SELECT_ADD	Adds the specified messages id.
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of messages id.

[in] msg address of array of message id.

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: mxfAsyncEventRxMsgSelectSet(); mxfAsyncEventHandlerInit(); mxfA429AsyncEventRxMsgSelectGet(); mxfAsyncEventConditionsSet()

Examples:: ar429_rx_event_handler.c, and ar429_rx_event_handler.cs.

uint32 mxfA429AsyncEventRxMsgSelectGet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_A429 *	msg
	)

C#: public static extern UInt32 mxfA429AsyncEventRxMsgSelectGet(UInt64 asyncEvent, UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A429[] msgid);

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

Note: This function is the specific version for ARINC 429 of the multi-protocol mxfAsyncEventRxMsgSelectGet() function.

Parameters

[in]	asyncEvent	asynchronous event handle.
[in]	channel	channel handle.
[in]	maxCount	maximum ID messages expected.
[out]	count	number of ID messages returned.
[out]	msg	returned message ID 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.0 and later.

See also: mxfAsyncEventRxMsgSelectGet(); mxfAsyncEventHandlerInit(); mxfA429AsyncEventRxMsgSelectSet(); mxfAsyncEventConditionsSet()

uint32 mxfA429EmbeddedNVStorageFileMsgSelectSet	(	HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		MXF_MSGID_A429 *	msgid
	)

C#: public static extern UInt32 mxfA429EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_A429[] msgid);

public static extern UInt32 mxfA429EmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, IntPtr msgId);

Selects / deselects the specified message IDs on a channel for automatic embedded non-volatile storage recording.

Note: This function should be called before the function mxfEmbeddedNVStorageFileMsgSelectEnableSet() that starts the logging of messages on file for the specific channel.; count set to 0 with a msg set to NULL means ALL message IDs.; This function is the specific version for A429 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectSet() function.

Parameters

[in] channel channel handle

[in]

select

action to perform with the provided selection list

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

[in] count count of messages

[in] msgid pointer to an array of message identifiers.

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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet(); mxfEmbeddedNVStorageFileMsgSelectGet()

Examples:: ar429_embedded_recorder.c, and ar429_embedded_recorder.cs.

uint32 mxfA429EmbeddedNVStorageFileMsgSelectGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_A429 *	msgid
	)

C#: public static extern UInt32 mxfA429EmbeddedNVStorageFileMsgSelectGet(UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_A429[] msgid);

Returns the specific message IDs registered on a channel for automatic embedded non-volatile storage recording.

Note: This function is the specific version for A429 of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectGet() function.

Parameters

[in]	channel	channel handle.
[in]	maxCount	maximum count of messages return in the array
[out]	count	count of messages returned
[out]	msgid	pointer to an array of message identifiers.

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: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectSet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet()

uint32 mxfA429EmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_A429_DATAREC *	msg
	)

C#: public static extern UInt32 mxfA429EmbeddedNVStorageFileMsgRead(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429.

Note: This function is the specific version for A429 of the multi-protocol mxfEmbeddedNVStorageFileMsgRead() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	file index
[in]	maxMsgCount	maximum number of messages that can be returned
[in]	maxBytesCount	maximum byte count that can be returned
[out]	msgCount	count of messages returned
[out]	byteCount	number of bytes returned in the msg buffer
[out]	msg	pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfA429NextDataRecordPtrGet() function.

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

Examples:: ar429_embedded_recorder.c, and ar429_embedded_recorder.cs.

uint32 mxfA429EmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxMsgCount,
		MXF_A429_DATAREC *	msg,
		uint64 *	count
	)

C#: public static extern UInt32 mxfA429EmbeddedNVStorageFileMsgWrite(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, IntPtr rec, out UInt64 count);

Writes messages to the specified file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_A429.

Note: This function is the specific version for A429 of the multi-protocol mxfEmbeddedNVStorageFileMsgWrite() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	file index
[in]	maxMsgCount	maximum number of messages to write
[in]	msg	pointer to messages to write. The records in the buffer need to be indexed using mxfA429NextDataRecordPtrGet() function.
[out]	count	number of messages actually written

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: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfA429ParametricTxVoltage	(	HMXF_CHANNEL	channel,
		double	voltage,
		uint64	load
	)

C#: public static extern UInt32 mxfA429ParametricTxVoltage(UInt64 channelHandle, double voltage, UInt64 load);

Sets the Tx High differential and Low differential voltage to achieve the desired output voltage for the desired load.
It will automatically set the KMXF_A429_ELECTRICAL_SELECTION attribute to VMXF_A429EH_MULTI_ELECTRICAL_SELECT_CUSTOM and KMXF_A429_TX_DIFF_VOLTAGE_HIGH and KMXF_A429_TX_DIFF_VOLTAGE_LOW attributes to the needed values to achieve the desired peak-to-peak output voltage for the desired load. The output voltage precision is +/-2.5%.

Note: This function is for A429 Tx with variable voltage channels only (FMOB-A844-P-U and FlexMulti devices and FMX-A429 modules).

Parameters

[in] channel A429 Tx parametric channel handle

[in]

voltage

desired output voltage

Model	Range (V)	Description
FMX-A429-4TV4R	1.0 – 16.0	Desired differential output voltage
Others	0.0 – 26.0	Desired peak-to-peak output voltage

[in]

load

Each load correspond to 8kΩ. (Two loads will correspond to 4kΩ, 20 loads will correspond to 400Ω).

Model	Range
FMX-A429	0 – 20
Others	1 – 20

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.
MAXT_ERROR_VALUE_OOR is returned if the voltage, load or resulting computation for the voltage is out of range.

Availability:: Available in MX Foundation 4.3.6 and later.

See also: KMXF_A429_ELECTRICAL_SELECTION; KMXF_A429_TX_DIFF_VOLTAGE_HIGH; KMXF_A429_TX_DIFF_VOLTAGE_LOW

API Functions Reference

Functions

Detailed Description

Function Documentation