Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Message Validation (SDI/Label Matching) I/O Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetLabelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t SDILabel, bool_t enable)
 Enables or disables matching for messages containing the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetLabelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t SDILabel, bool_t *p_outenable)
 Gets the current match enable setting of the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, all ARINC messages (without errors) will get stored regardless of the SDI/Label's match enable setting.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetLabelEnableAll (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or disables matching for all 1024 SDI/Labels (0x0 to 0x3FF). If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.
 

Detailed Description

Function Documentation

◆ naibrd_AR_GetLabelEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_GetLabelEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t SDILabel,
bool_t * p_outenable )

Gets the current match enable setting of the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, all ARINC messages (without errors) will get stored regardless of the SDI/Label's match enable setting.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
SDILabel: (Input) The lower 10 bits of the Arinc Word to match, also referred to as SDI/Label (0x0 to 0x3FF).
p_outenable: (Output) NAI_FALSE if matching for this label is disabled. NAI_TRUE if matching for this label is enabled.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetLabelEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AR_SetLabelEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t SDILabel,
bool_t enable )

Enables or disables matching for messages containing the user specified SDI/Label. If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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]).
SDILabel: (Input) The lower 10 bits of the Arinc Word to match, also referred to as SDI/Label (0x0 to 0x3FF).
enable: (Input) NAI_FALSE to disable matching for this SDI/Label. NAI_TRUE to enable matching for this SDI/Label.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid SDILabel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AR_SetLabelEnableAll()

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

Enables or disables matching for all 1024 SDI/Labels (0x0 to 0x3FF). If Message Validation is enabled (using naibrd_AR_SetRxValidationEnable() function) for the channel, only ARINC messages containing SDI/Labels that have enabled matching will get stored. If Message Validation is not enabled for the channel, this function has no effect and all ARINC messages (without errors) will get stored.

Parameters
cardIndex: (Input) Logical Card Index assigned to connect 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) NAI_FALSE to disable matching for all SDI/Labels. NAI_TRUE to enable matching for all SDI/Labels.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.