Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Module Enhanced Operations
NAI Board Library - Module Functions » TTL Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_enable_type_t enable)
 Sets enhanced operation to disabled or enabled for specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_enable_type_t *p_outenable)
 Retrieves the present enhance operation enable state for the specified channel. Power on default configuration for the channels is Enhanced Input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhancedMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_enhanced_mode_t mode)
 Sets the Enhanced mode for the specified channel. Default configuration for the channels is Enhanced Input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhancedMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_enhanced_mode_t *p_outmode)
 Retrieves the Operation mode in Enhanced mode for the specified channel. Default configuration for the channels is Enhanced Input.
 

Detailed Description

Function Documentation

◆ naibrd_TTL_GetEnhancedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhancedMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_enhanced_mode_t * p_outmode )

Retrieves the Operation mode in Enhanced mode for the specified channel. Default configuration for the channels is Enhanced Input.

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_outmode: (Input) Available operation modes: Refer to nai_ttl_enhanced_mode_t definitions.
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_TTL_GetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_enable_type_t * p_outenable )

Retrieves the present enhance operation enable state for the specified channel. Power on default configuration for the channels is Enhanced Input.

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) Refer to nai_ttl_enable_type_t definitions.
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_TTL_SetEnhancedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhancedMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_enhanced_mode_t mode )

Sets the Enhanced mode for the specified channel. Default configuration for the channels is Enhanced Input.

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]).
mode: (Input) Available operation modes: Refer to nai_ttl_enhanced_mode_t definitions.
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_TTL_SetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ttl_enable_type_t enable )

Sets enhanced operation to disabled or enabled for specified 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]).
enable: (Input) Refer to nai_ttl_enable_type_t definitions.
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.