Functions
uint32	mxfFlexAnalogTxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_FLEXANALOG_DATAREC *rec)

uint32	mxfFlexAnalogRxAcqRead (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, uint64 status, uint64 msgCount, uint64 byteCount, MXF_FLEXANALOG_DATAREC rec)

uint32	mxfFlexAnalogRxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_FLEXANALOG_SAMPREC *rec)

uint32	mxfFlexAnalogNextDataRecordPtrGet (MXF_FLEXANALOG_DATAREC currentRec, MXF_FLEXANALOG_DATAREC *nextRec)

uint32	mxfFlexAdcSamplingSync (HMXF_MODULE module, uint64 period, uint64 startTime)

uint32	mxfFlexAdcDataConvert (HMXF_CHANNEL channel, uint16 rawData, float *value)

uint32	mxfFlexDacDataConvert (HMXF_CHANNEL channel, float value, uint16 *rawData)

Detailed Description

Function Documentation

uint32 mxfFlexAnalogTxAperiodicWrite	(	HMXF_BUFFER	buffer,
		uint64	options,
		uint64	startTime,
		uint64	count,
		MXF_FLEXANALOG_DATAREC *	rec
	)

C#: public static extern UInt32 mxfFlexAnalogTxAperiodicWrite(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 an optional time tag. The first data item is transmitted at the specified starting 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 Flex Analog IO of the multi-protocol mxfTxAperiodicWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	options	options for controlling the transmitter before 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	pointer to MXF_FLEXANALOG_DATAREC records to write. The records in the buffer need to be indexed using the mxfFlexAnalogNextDataRecordPtrGet() function.

The options 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 the 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 can’t 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.5.6 and later.

See also: mxfTxAperiodicWrite(); mxfTxAperiodicBufferAlloc(); mxfTxAperiodicBufferStatusGet(); mxfTxAperiodicClear(); mxfSystemTimeBaseSet(); mxfFlexAnalogNextDataRecordPtrGet()

Examples:: flexdac.c, flexdac_buffer_threshold.c, and flexdac_relative_timing.c.

uint32 mxfFlexAnalogRxAcqRead	(	HMXF_BUFFER	buffer,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	status,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_FLEXANALOG_DATAREC *	rec
	)

C#: public static extern UInt32 mxfFlexAnalogRxAcqRead(UInt64 buffer, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 msgCount, out UInt64 byteCount, IntPtr rec);

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

Note: This function is the specific version for Flex Analog IO of the multi-protocol mxfRxAcqRead() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxMsgCount	maximum messages to read (0 means all messages).
[in]	maxBytesCount	maximum number of bytes to be read.
[out]	status	last status set.
[out]	msgCount	number of records returned.
[out]	byteCount	number of bytes returned.
[out]	rec	address of data records. The records in the buffer need to be indexed using mxfFlexAnalogNextDataRecordPtrGet() 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.5.6 and later.

See also: mxfRxAcqRead(); mxfRxAcqStart(); mxfRxAcqBufferAlloc(); mxfRxAcqStop(); mxfFlexAnalogNextDataRecordPtrGet()

Examples:: flexadc.c, and flexadc_buffer_threshold.c.

uint32 mxfFlexAnalogRxSamplingRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_FLEXANALOG_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfFlexAnalogRxSamplingRead(UInt64 buffer, UInt64 flags, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 msgCount, out UInt64 byteCount, IntPtr rec);

Reads the sampling record from the sampling buffer to the application buffer.

The sampling process keeps the last record received. A record is considered received if it 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 as well as the latest ADC value.

Note: This function is the specific version for Flex Analog IO 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. Normally one, maximum of one sampling record available.

[in] maxBytesCount maximum number of bytes to read. Normally sizeof MXF_FLEXANALOG_SAMPREC structure.

[out] msgCount number of messages returned.

[out] byteCount number of bytes returned.

[out] rec pointer to MXF_FLEXANALOG_SAMPREC record 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.5.6 and later.

See also: mxfRxSamplingRead(); mxfRxSamplingBufferAlloc(); mxfRxSamplingMsgSelectSet(); mxfRxSamplingStart()

Examples:: flexadc_sampling.c.

uint32 mxfFlexAnalogNextDataRecordPtrGet	(	MXF_FLEXANALOG_DATAREC *	currentRec,
		MXF_FLEXANALOG_DATAREC **	nextRec
	)

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

Returns the next buffer address in a MXF_FLEXANALOG_DATAREC buffer array.

Note: This function is the specific version for Flex Analog IO 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.5.6 and later.

See also: mxfNextRecordPtrGet(); mxfFlexAnalogRxAcqRead(); mxfFlexAnalogTxAperiodicWrite()

Examples:: flexadc.c, flexadc_buffer_threshold.c, flexdac_buffer_threshold.c, and flexdac_relative_timing.c.

uint32 mxfFlexAdcSamplingSync	(	HMXF_MODULE	module,
		uint64	period,
		uint64	startTime
	)

C#: public static extern UInt32 mxfFlexAdcSamplingSync(UInt64 module, UInt64 period, UInt64 startTime);

Sets the period and the start time of the sampling period for a module.

Useful to synchronize the start of sampling of multiple modules at the same time.

Parameters

[in]	module	module handle.
[in]	period	period (1-1000 ms) based on the timebase resolution.
[in]	startTime	Absolute start time based on the timebase format (max of 30 seconds in the future).

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.5.6 and later.

uint32 mxfFlexAdcDataConvert	(	HMXF_CHANNEL	channel,
		uint16	rawData,
		float *	value
	)

C#: public static extern UInt32 mxfFlexAdcDataConvert(UInt64 channel, UInt16 rawData, out float value);

Converts ADC code to voltage value.
Use range, slope and offset to compute the voltage value from the ADC code.
Note that these attributes value are per process.

Parameters

[in]	channel	channel handle.
[in]	rawData	ADC code, usually from record data.
[out]	value	Converted voltage 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.5.6 and later.

Examples:: flexadc.c, flexadc_buffer_threshold.c, and flexadc_sampling.c.

uint32 mxfFlexDacDataConvert	(	HMXF_CHANNEL	channel,
		float	value,
		uint16 *	rawData
	)

C#: public static extern UInt32 mxfFlexDacDataConvert(UInt64 channel, float value, out UInt16 rawData);

Converts voltage value to DAC code.

Use range to compute the DAC code from the voltage value.
Note that this attribute value is per process.

Parameters

[in]	channel	channel handle.
[in]	value	Voltage value to convert.
[out]	rawData	DAC code, usually to set in record 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.5.6 and later.

Examples:: flexdac.c, flexdac_buffer_threshold.c, and flexdac_relative_timing.c.

Functions

Detailed Description

Function Documentation