Raw Register Access Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_GetChannelStatusRaw (int32_t cardIndex, int32_t module, uint32_t channel, nai_ref_status_access_type_t accessType, uint32_t *outstatusraw)
	Retrieves the raw data value in the status register associated with the status type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_ClearChannelStatusRaw (int32_t cardIndex, int32_t module, uint32_t channel)
	Retrieves the raw data value in the status register associated with the status type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_SetValueRaw (int32_t cardIndex, int32_t module, 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_GetValueRaw (int32_t cardIndex, int32_t module, 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_GetMeasuredValueRaw (int32_t cardIndex, int32_t module, 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_ClearChannelStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChannelStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	channel )

Retrieves the raw data value in the status register associated with the status type specified.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_REF_GetChannelStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	channel,
		nai_ref_status_access_type_t	accessType,
		uint32_t *	outstatusraw )

Retrieves the raw data value in the status register associated with the status type specified.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
accessType	: (Input) Latched or Realtime status: refer to nai_ref_status_access_type_t definition.
outstatusraw	: (Output) Raw Data Value.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_REF_GetMeasuredValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValueRaw	(	int32_t	cardIndex,
		int32_t	module,
		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).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
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_GetValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValueRaw	(	int32_t	cardIndex,
		int32_t	module,
		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).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
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_SetValueRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValueRaw	(	int32_t	cardIndex,
		int32_t	module,
		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).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
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.