Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Saturation Control Functions
NAI Board Library - Module Functions » AD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetSaturationControl (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_saturation_control_type_t saturationType, bool_t enable)
 Enables/Disables the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetSaturationControl (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_saturation_control_type_t saturationType, bool_t *p_outenable)
 Retrieves the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetSaturationLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_saturation_control_type_t saturationType, float64_t level)
 Sets the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will set the lower limit of the channel's reading to the value specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will set the upper limit of the channel's upper reading to the value specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetSaturationLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_saturation_control_type_t saturationType, float64_t *p_outlevel)
 Retrieves the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will get the lower saturation limit of the channel specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will get the upper saturation limit of the channel specified.
 

Detailed Description

Function Documentation

◆ naibrd_AD_GetSaturationControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetSaturationControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_saturation_control_type_t saturationType,
bool_t * p_outenable )

Retrieves the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.

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]).
saturationType: (Input) Either NAI_AD_SATURATION_CONTROL_LOW or NAI_AD_SATURATION_CONTROL_HIGH.
p_outenable: (Output) enabled = NAI_TRUE, disabled = NAI_FALSE.
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. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.

◆ naibrd_AD_GetSaturationLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetSaturationLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_saturation_control_type_t saturationType,
float64_t * p_outlevel )

Retrieves the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will get the lower saturation limit of the channel specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will get the upper saturation limit of the channel 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
saturationType: (Output) Either NAI_AD_SATURATION_CONTROL_LOW or NAI_AD_SATURATION_CONTROL_HIGH.
p_outlevel: (Output) saturation limit level.
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. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.

◆ naibrd_AD_SetSaturationControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetSaturationControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_saturation_control_type_t saturationType,
bool_t enable )

Enables/Disables the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.

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]).
saturationType: (Input) Either NAI_AD_SATURATION_CONTROL_LOW or NAI_AD_SATURATION_CONTROL_HIGH.
enable: (Input) enable = NAI_TRUE, disable = NAI_FALSE.
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_AD_SetSaturationLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetSaturationLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_saturation_control_type_t saturationType,
float64_t level )

Sets the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will set the lower limit of the channel's reading to the value specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will set the upper limit of the channel's upper reading to the value 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
saturationType: (Output) Either NAI_AD_SATURATION_CONTROL_LOW or NAI_AD_SATURATION_CONTROL_HIGH.
level: (Input) saturation limit level.
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. NAI_ERROR_INVALID_VALUE when an invalid saturationType is specified.