Software Library API naibrd 1.62
See all documentation at naii.docs.com
On-board reference Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetOnBoardRefCtrl (int32_t cardIndex, int32_t module, nai_ds_on_board_ref_type_t type, float64_t inRefCtrl)
 Sets the on board internal reference properties from a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetOnBoardRefCtrl (int32_t cardIndex, int32_t module, nai_ds_on_board_ref_type_t type, float64_t *outRefCtrl)
 Gets the on board internal reference controls from the D/S module.
 

Detailed Description


Function Documentation

◆ naibrd_DS_GetOnBoardRefCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetOnBoardRefCtrl ( int32_t cardIndex,
int32_t module,
nai_ds_on_board_ref_type_t type,
float64_t * outRefCtrl )

Gets the on board internal reference controls from the D/S module.

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) Angle Type: refer to nai_ds_on_board_ref_type_t definitions.
outRefCtrl: (Output) Returns on-board reference properties.
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetOnBoardRefCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetOnBoardRefCtrl ( int32_t cardIndex,
int32_t module,
nai_ds_on_board_ref_type_t type,
float64_t inRefCtrl )

Sets the on board internal reference properties from a D/S module.

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) Angle Type: refer to nai_ds_on_board_ref_type_t definitions.
inRefCtrl: (Input) Writes on-board reference properties.
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.