On-Board Standard Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_SetValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, float64_t inValue)
	Sets operational properties (voltage, frequencies, ect..) for the on-board reference module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_GetValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_value_type_t type, float64_t *outValue)
	Gets operational properties (voltage, frequencies, ect..) for the on-board reference module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_GetMeasuredValue (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, nai_ref_measured_type_t type, float64_t *outValue)
	Gets the measured operational values from the on-board reference module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_REF_Onbrd_GetOverCurrentStatus (int32_t cardIndex, nai_ref_external_control_type_t extmodctrl, bool_t *outOverCurrent)
	Gets the over current status of the on-board reference module. Not all reference module supports this function.

Detailed Description

Function Documentation

naibrd_REF_Onbrd_GetMeasuredValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetMeasuredValue	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_measured_type_t	type,
		float64_t *	outValue )

Gets the measured operational values from the on-board reference module.

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.
outValue	: (Output) Measured Values: returns the measured values for the specified property type from the device.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetOverCurrentStatus	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		bool_t *	outOverCurrent )

Gets the over current status of the on-board reference module. Not all reference module supports this function.

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.
outOverCurrent	: (Output) bool_t *outOverCurrent: returns the over current status of the reference module.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_GetValue	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_value_type_t	type,
		float64_t *	outValue )

Gets operational properties (voltage, frequencies, ect..) for the on-board reference module.

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.
outValue	: (Output) Operational properties: returns the current operational value for the specified property type stored in the device.

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_INVALID_VALUE when invalid status type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_REF_Onbrd_SetValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_Onbrd_SetValue	(	int32_t	cardIndex,
		nai_ref_external_control_type_t	extmodctrl,
		nai_ref_value_type_t	type,
		float64_t	inValue )

Sets operational properties (voltage, frequencies, ect..) for the on-board reference module.

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.
inValue	: (Input) Operational properties: refer to NAI manual for the device's operational ranges

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_INVALID_VALUE when invalid status type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.