Software Library API naibrd 2.24.0
See all documentation at naii.docs.com

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ref_chan_mapped_status_type_t statusType, uint32_t *p_outstatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_ref_chan_mapped_status_type_t statusType, uint32_t clearStatusRaw)
 Retrieves the raw data value in the status register associated with the status type specified. Note: The result of attempting to clear a realtime status may be unpredictable.
 

Detailed Description

Function Documentation

◆ naibrd_REF_ClearChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ref_chan_mapped_status_type_t statusType,
uint32_t clearStatusRaw )

Retrieves the raw data value in the status register associated with the status type specified. Note: The result of attempting to clear a realtime status may be unpredictable.

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]).
statusType: (Input) Latched or Realtime status: refer to naibrd_ref_chan_mapped_status_type_t definition.
clearStatusRaw: (Input) 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_GetChanMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChanMappedStatusRaw ( int32_t cardIndex,
int32_t module,
naibrd_ref_chan_mapped_status_type_t statusType,
uint32_t * p_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]).
statusType: (Input) Latched or Realtime status: refer to naibrd_ref_chan_mapped_status_type_t definition.
p_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.