Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Standard Operation Functions
NAI Board Library - Module Functions » SG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStrain (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outstrain)
 Retrieves the calculated strain for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutputVoutVexc (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outoutputvv)
 Retrieves the Vout/Vexcitation voltage ratio for the specified SG Channel in units of V/V. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMinStrainValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outminStrainValue)
 Retrieves the minimum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMaxStrainValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outmaxStrainValue)
 Retrieves the maximum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRawADReading (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outrawADReading)
 Retrieves the raw A/D channel voltage reading for the specified SG Channel. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sg_chan_mapped_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sg_chan_mapped_status_type_t type)
 Clears the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type)
 Clears the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 

Detailed Description

Function Documentation

◆ naibrd_SG_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sg_chan_mapped_status_type_t type )

Clears the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.

Note: The Open Status is currently not supported.

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) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type )

Clears the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG 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]).
type: (Input) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sg_chan_mapped_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.

Note: The Open Status is currently not supported.

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) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outstatusBit: (Output) 0 for Normal, 1 for Failure Detected.
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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetMaxStrainValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMaxStrainValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outmaxStrainValue )

Retrieves the maximum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.

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_outmaxStrainValue: (Output) A pointer to where the maximum strain value is returned.
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_SG_GetMinStrainValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMinStrainValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outminStrainValue )

Retrieves the minimum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.

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_outminStrainValue: (Output) A pointer to where the minimum strain value is returned.
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_SG_GetOutputVoutVexc()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutputVoutVexc ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outoutputvv )

Retrieves the Vout/Vexcitation voltage ratio for the specified SG Channel in units of V/V. This function is only supported by modules that are Generation 5 or later.

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_outoutputvv: (Output) A pointer to where the Vout/Vexc ratio is returned.
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_SG_GetRawADReading()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRawADReading ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outrawADReading )

Retrieves the raw A/D channel voltage reading for the specified SG Channel. This function is only supported by modules that are Generation 5 or later.

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_outrawADReading: (Output) A pointer to where the raw A/D reading is returned.
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_SG_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.

These functions are deprecated and replaced by API functions in naibrd_sg.c

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) Channel-Mapped Status Type: refer to naibrd_sg_chan_mapped_status_type_t definition.
p_outstatusBit: (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 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_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetStrain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStrain ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outstrain )

Retrieves the calculated strain for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.

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_outstrain: (Output) A pointer to where the strain value is returned.
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.