Software Library API naibrd 1.62
See all documentation at naii.docs.com
Module Measurement Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleMeasurement (int32_t cardIndex, int32_t module, nai_module_meas_type_t measType, float64_t *p_outmoduleMeas)
 Retrieves the module measured value based on the module measured value type specified. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleMeasurementRaw (int32_t cardIndex, int32_t module, nai_module_meas_raw_type_t rawMeasType, uint32_t *p_outrawModuleMeas)
 Retrieves the raw register module measured value based on the module measured value raw type specified. This feature is only available on the Xilinx Generation 5 platforms.
 

Detailed Description


Function Documentation

◆ naibrd_GetModuleMeasurement()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleMeasurement ( int32_t cardIndex,
int32_t module,
nai_module_meas_type_t measType,
float64_t * p_outmoduleMeas )

Retrieves the module measured value based on the module measured value type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
measType: (Input) Measured value type: refer to nai_module_meas_type_t definition.
p_outmoduleMeas: (Output) Measured value read from module.
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_VALUE when invalid measType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetModuleMeasurementRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleMeasurementRaw ( int32_t cardIndex,
int32_t module,
nai_module_meas_raw_type_t rawMeasType,
uint32_t * p_outrawModuleMeas )

Retrieves the raw register module measured value based on the module measured value raw type specified. This feature is only available on the Xilinx Generation 5 platforms.

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]).
rawMeasType: (Input) Measured value raw type: refer to nai_module_meas_raw_type_t definition.
p_outrawModuleMeas: (Output) Raw measured value read from module.
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_VALUE when invalid rawMeasType parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.