On-Board Raw Register Access Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_SetValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, uint32_t inRawData)
	Sets the raw data value in the register associated to the property type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_GetValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, uint32_t *outRawData)
	Gets the raw data value in the register associated to the property type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_GetMeasuredValueRaw (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_measured_type_t type, uint32_t *outRawData)
	Gets the measured raw data value in the register of the reference module associated to the specified type.

Detailed Description

Function Documentation

naibrd_REF_Onbrd_GetMeasuredValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetMeasuredValueRaw	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_measured_type_t	type,
		uint32_t *	outRawData )

Gets the measured raw data value in the register of the reference module associated to the specified type.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
extmodctrl	: (Input) Module Type of the controlling module.
type	: (Input) Status Type: refer to nai_ref_measured_type_t definitions.
outRawData	: (Output) uint32_t Raw Data.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_REF_Onbrd_GetValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetValueRaw	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_value_type_t	type,
		uint32_t *	outRawData )

Gets the raw data value in the register associated to the property type specified.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
extmodctrl	: (Input) Module Type of the controlling module.
type	: (Input) Status Type: refer to nai_ref_value_type_t definitions.
outRawData	: (Output) uint32_t Raw Data.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_REF_Onbrd_SetValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_SetValueRaw	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_value_type_t	type,
		uint32_t	inRawData )

Sets the raw data value in the register associated to the property type specified.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
extmodctrl	: (Input) Module Type of the controlling module.
type	: (Input) Status Type: refer to nai_ref_value_type_t definitions.
inRawData	: (Input) Raw Data.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
• NAI_ERROR_NOT_OPEN when handle to board is invalid.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.