Software Library API naibrd 1.62
See all documentation at naii.docs.com
IRIG Basic Configuration Functions: Input Termination

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetInputAnalogTermEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enable or disable IRIG input analog termination.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetInputAnalogTermEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outEnable)
 Gets the enable or disable state of the IRIG input analog termination setting.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetInputDigitalTermEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enable or disable the IRIG input digital termination.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetInputDigitalTermEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outEnable)
 Gets the enable or disable state of the IRIG input digital termination setting.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetInputAnalogTermEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetInputAnalogTermEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outEnable )

Gets the enable or disable state of the IRIG input analog termination setting.

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]).
p_outEnable: (Output) TRUE if enabled, FALSE if disabled.
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_IRIG_GetInputDigitalTermEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetInputDigitalTermEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outEnable )

Gets the enable or disable state of the IRIG input digital termination setting.

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]).
p_outEnable: (Output) TRUE if enabled, FALSE if disabled.
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_IRIG_SetInputAnalogTermEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetInputAnalogTermEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enable or disable IRIG input analog termination.

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]).
enable: (Input) TRUE to enable, FALSE to disable.
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_IRIG_SetInputDigitalTermEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetInputDigitalTermEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enable or disable the IRIG input digital termination.

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]).
enable: (Input) TRUE to enable, FALSE to disable.
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.