AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Data.IMeasurementFormula Interface Reference

The contract to be used by entities providing formulae for determining measurement values. More...

Inheritance diagram for Apac.Data.IMeasurementFormula:
Apac.Data.MeasurementFormula Apac.Dallas.OneWire.OneWireDevice10.TempCalculatorC Apac.Dallas.OneWire.OneWireDevice10.TempCalculatorF Apac.Dallas.OneWire.OneWireDevice26.RelativeHumidity Apac.Dallas.OneWire.OneWireDevice26.TempCalculatorC Apac.Dallas.OneWire.OneWireDevice26.TempCalculatorF Apac.Dallas.OneWire.OneWireDevice28.TempCalculatorC Apac.Dallas.OneWire.OneWireDevice28.TempCalculatorF Apac.Plugins.Formulae.AmpsToKilowattsFormula Apac.Plugins.Formulae.BinarizationFormula Apac.Plugins.Formulae.DiscretizationFormula Apac.Plugins.Formulae.MockTempF Apac.Plugins.Formulae.TempDeltaFlowBtuFormula

Public Member Functions

decimal ProcessMeasurement (Monitoring.Measurement measurement, decimal resolution, Apac.Settings.Configuration config)
 Should process the measurement at the given resolution and return a value according to the encoded formula. More...
 

Properties

Apac.Monitoring.MeasurementUnit Units [get]
 Indicates the units to be applied to the result of ProcessMeasurement. More...
 
Configuration.FormulaDescriptor Descriptor [get]
 Presents the metadata about this formula for use during configuration and troubleshooting scenarios. More...
 

Detailed Description

The contract to be used by entities providing formulae for determining measurement values.

Template Parameters
T

Member Function Documentation

◆ ProcessMeasurement()

decimal Apac.Data.IMeasurementFormula.ProcessMeasurement ( Monitoring.Measurement  measurement,
decimal  resolution,
Apac.Settings.Configuration  config 
)

Should process the measurement at the given resolution and return a value according to the encoded formula.

Parameters
measurementThe Monitoring.Measurement to be processed.
resolutionThe resolution at which measurement should be processed.
configThe configuration settings under which the routine should function. Some implemenations may ignore this parameter altogether.
Returns
Returns a formulaic result based on the value of measurement 's configured sensor range, its resolution, and its source value.

Property Documentation

◆ Descriptor

Configuration.FormulaDescriptor Apac.Data.IMeasurementFormula.Descriptor
get

Presents the metadata about this formula for use during configuration and troubleshooting scenarios.

◆ Units

Apac.Monitoring.MeasurementUnit Apac.Data.IMeasurementFormula.Units
get

Indicates the units to be applied to the result of ProcessMeasurement.


The documentation for this interface was generated from the following file: