Logo
MSP Gas Metering Library
Algorithm_api

Functions

GASMETERING_return_code GASMETERING_intializeAlgorithm (GASMETERING_configuration *pLibraryConfig)
 Initializes algorithm. More...
 
GASMETERING_return_code GASMETERING_runAlgorithm (GASMETERING_configuration *pLibraryConfig, GASMETERING_Algorithms_Results *pResults)
 Runs ToF algorithm. More...
 

Detailed Description

Function Documentation

GASMETERING_return_code GASMETERING_intializeAlgorithm ( GASMETERING_configuration pLibraryConfig)

Initializes algorithm.

This API must be called before calling GASMETERING_runAlgorithm API. Failure to call this function might result in unknown behavior.

Parameters
pLibraryConfigpointer to GAS Metering library configuration structure
Returns
GASMETERING_return_code
GASMETERING_return_code GASMETERING_runAlgorithm ( GASMETERING_configuration pLibraryConfig,
GASMETERING_Algorithms_Results pResults 
)

Runs ToF algorithm.

This API allows user to obtain Absolute Time of Flight, Delta ToF and volume flow rate. The have control on which calculation are run based on the selection of the following members of GASMETERING_Algorithms_Configuration structure:

  • isRunAbsToFUpEnabled
  • isRunAbsToFDownEnabled
  • isRunDeltaToFUpEnabled
  • isRunFlowEnabled
Parameters
pLibraryConfigpointer to GAS Metering library configuration structure
pResultspointer to result structure.
Returns
GASMETERING_return_code