Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Angle Change Alert Functions
NAI Board Library - Module Functions » SD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetAngleDelta (int32_t cardIndex, int32_t module, int32_t channel, float64_t angleDelta)
 Sets the angle delta in degrees before indicating an angle delta alert for the specified channel. Setting the angle delta to zero disables the Angle Delta alert.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngleDelta (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outAngleDelta)
 Retrieves the angle delta in degrees before indicating an angle delta alert from the specified channel. Setting the angle delta to zero disables the Angle Delta alert.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetAngleDataInit (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Set Angle Delta Monitoring for the channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngleDataInit (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outEnable)
 Retrieves the current state of Angle Delta Monitoring for the channel specified.
 

Detailed Description

Function Documentation

◆ naibrd_SD_GetAngleDataInit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngleDataInit ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outEnable )

Retrieves the current state of Angle Delta Monitoring for 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]).
p_outEnable: (Output) Returns NAI_TRUE if enabled and NAI_FALSE if disabled.
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_SD_GetAngleDelta()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngleDelta ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outAngleDelta )

Retrieves the angle delta in degrees before indicating an angle delta alert from the specified channel. Setting the angle delta to zero disables the Angle Delta alert.

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_outAngleDelta: (Output) 0.0 or 0.05 <= AngleDelta <= 179.995 Deg.
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_SD_SetAngleDataInit()

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

Set Angle Delta Monitoring for 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]).
enable: (Input) NAI_TRUE to enable. NAI_FALSE to disable.
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 enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetAngleDelta()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetAngleDelta ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t angleDelta )

Sets the angle delta in degrees before indicating an angle delta alert for the specified channel. Setting the angle delta to zero disables the Angle Delta alert.

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]).
angleDelta: (Input) 0.0 or 0.05 <= AngleDelta <= 179.995 Deg.
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 angleDelta parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.