Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
TTL Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOutputState (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_state_t state)
 Sets the Output State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOutputState (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_state_t *outstate)
 Retrieves the Output State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_state_t *inputstate)
 Retrieves the Input State for the specified TTL channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_status_type_t type, nai_status_bit_t *outstatusVal)
 Retrieves the realtime or continuous status for the specified TTL channel and status type. Realtime status always represents the present status at the time of the read, as opposed to the latched status, which retains transient indications until cleared.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_status_type_t type)
 Clears the latched status for the specified TTL channel and status type.
 

Detailed Description


Function Documentation

◆ naibrd_TTL_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_status_type_t type )

Clears the latched status for the specified TTL channel and status type.

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]).
type: (Input) Status Type: refer to nai_ttl_status_type_t definition.
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_INVALID_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_state_t * inputstate )

Retrieves the Input State for the specified TTL channel.

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]).
inputstate: (Output) NAI_TTL_STATE_LO or NAI_TTL_STATE_HI.
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_TTL_GetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_state_t * outstate )

Retrieves the Output State for the specified TTL channel.

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]).
outstate: (Output) NAI_TTL_STATE_LO or NAI_TTL_STATE_HI.
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_TTL_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_status_type_t type,
nai_status_bit_t * outstatusVal )

Retrieves the realtime or continuous status for the specified TTL channel and status type. Realtime status always represents the present status at the time of the read, as opposed to the latched status, which retains transient indications until cleared.

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]).
type: (Input) Status Type: refer to nai_ttl_status_type_t definitions.
outstatusVal: (Output) 0 for Normal, 1 Failure Detected.
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_INVALID_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_state_t state )

Sets the Output State for the specified TTL channel.

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]).
state: (Input) NAI_TTL_STATE_LO or NAI_TTL_STATE_HI.
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.