Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Event Operation Functions
DIF/CTS Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_FlushQueues (int32_t cardIndex, int32_t module)
 Flushes the Queue for the specified DIF CTS module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_WriteEvent (int32_t cardIndex, int32_t module, uint32_t course, uint32_t fine, uint32_t data)
 Writes an event to the specified DIF CTS module.
 

Detailed Description


Function Documentation

◆ naibrd_DIF_CTS_FlushQueues()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_FlushQueues ( int32_t cardIndex,
int32_t module )

Flushes the Queue for the specified DIF CTS 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]).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_DIF_CTS_WriteEvent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DIF_CTS_WriteEvent ( int32_t cardIndex,
int32_t module,
uint32_t course,
uint32_t fine,
uint32_t data )

Writes an event to the specified DIF CTS 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]).
course: (Input) Value of Course event to set.
fine: (Input) Value of Fine event to set.
data: (Input) Value of event data to set.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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.