Onboard Reference Function

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SD_SetOnboardRefFreq (int32_t cardIndex, int32_t module, float64_t frequency)
	Sets the Frequency in Hz for the Optional Onboard Reference Supply. Frequency range is 47 to 10000 Hz.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SD_GetOnboardRefFreq (int32_t cardIndex, int32_t module, float64_t *outfrequency)
	Retrieves the Frequency in Hz for the Optional Onboard Reference Supply. Frequency range is 47 to 10000 Hz.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SD_SetOnboardRefVoltage (int32_t cardIndex, int32_t module, float64_t voltage)
	Sets the Voltage in volts for the Optional Onboard Reference Supply. Voltage range is 2 to 115 volts.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SD_GetOnboardRefVoltage (int32_t cardIndex, int32_t module, float64_t *outvoltage)
	Retrieves the Voltage in volts for the Optional Onboard Reference Supply. Voltage range is 2 to 115 volts.

Detailed Description

Function Documentation

naibrd_SD_GetOnboardRefFreq()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetOnboardRefFreq	(	int32_t	cardIndex,
		int32_t	module,
		float64_t *	outfrequency )

Retrieves the Frequency in Hz for the Optional Onboard Reference Supply. Frequency range is 47 to 10000 Hz.

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]).
outfrequency	: (Output) 47 <= Frequency <= 10000 Hz.

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_NOT_SUPPORTED when function is not supported.

naibrd_SD_GetOnboardRefVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetOnboardRefVoltage	(	int32_t	cardIndex,
		int32_t	module,
		float64_t *	outvoltage )

Retrieves the Voltage in volts for the Optional Onboard Reference Supply. Voltage range is 2 to 115 volts.

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]).
outvoltage	: (Output) 2 <= voltage <= 115 volts.

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_NOT_SUPPORTED when function is not supported.

naibrd_SD_SetOnboardRefFreq()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetOnboardRefFreq	(	int32_t	cardIndex,
		int32_t	module,
		float64_t	frequency )

Sets the Frequency in Hz for the Optional Onboard Reference Supply. Frequency range is 47 to 10000 Hz.

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]).
frequency	: (Input) 47 <= Frequency <= 10000 Hz.

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_NOT_SUPPORTED when function is not supported.

naibrd_SD_SetOnboardRefVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetOnboardRefVoltage	(	int32_t	cardIndex,
		int32_t	module,
		float64_t	voltage )

Sets the Voltage in volts for the Optional Onboard Reference Supply. Voltage range is 2 to 115 volts.

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]).
voltage	: (Input) 2 <= voltage <= 115 volts.

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_NOT_SUPPORTED when function is not supported.