AP&C API Reference
Public Member Functions | Protected Member Functions | List of all members
Apac.Plugins.Formulae.DiscretizationFormula Class Reference
Inheritance diagram for Apac.Plugins.Formulae.DiscretizationFormula:
Apac.Data.MeasurementFormula Apac.Configuration.Plugin< MeasurementFormulaAttribute, FormulaDescriptor > Apac.Data.IMeasurementFormula

Public Member Functions

 DiscretizationFormula ()
 Initializes a new instance of the DiscretizationFormula class. More...
 
- Public Member Functions inherited from Apac.Data.MeasurementFormula
decimal ProcessMeasurement (Apac.Monitoring.Measurement measurement, decimal resolution, Apac.Settings.Configuration config)
 Processes the measurement. More...
 
void GetObjectData (SerializationInfo info, StreamingContext context)
 
- Public Member Functions inherited from Apac.Data.IMeasurementFormula
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...
 

Protected Member Functions

 DiscretizationFormula (SerializationInfo info, StreamingContext context)
 
override decimal OnProcessMeasurement (Monitoring.Measurement measurement, decimal resolution, Settings.Configuration config)
 This routine converts the raw reading into a discrete value based on the other inputs which control the threshold values. The threshold values define ranges of continuous values and their associated discrete values. This can be specialized to do binarization of values by supplying the minimum set of inputs with the discrete values being zero (0) and (1). This is not a thresholding operation, but a way to take a stream of data that has continous values and normalize them into discrete values. More...
 
- Protected Member Functions inherited from Apac.Data.MeasurementFormula
 MeasurementFormula (Monitoring.MeasurementUnit units)
 Initializes a new instance of the MeasurementFormula<T> class. More...
 
 MeasurementFormula (SerializationInfo info, StreamingContext context)
 Initializes a new instance of the MeasurementFormula<T> class. More...
 
abstract decimal OnProcessMeasurement (Apac.Monitoring.Measurement measurement, decimal resolution, Apac.Settings.Configuration config)
 Called when the formula should process the incoming measurement (readings). More...
 

Additional Inherited Members

- Properties inherited from Apac.Data.MeasurementFormula
Apac.Monitoring.MeasurementUnit Units [get]
 Gets the units. More...
 
- Properties inherited from Apac.Configuration.Plugin< MeasurementFormulaAttribute, FormulaDescriptor >
virtual log4net.ILog Log [get]
 Gets the log. It lazy loads as necessary. More...
 
Guid Id [get]
 Gets the id of the formula from the subclass's PluginAttribute. More...
 
string Name [get]
 Gets the name of the formula from the subclass's PluginAttribute. More...
 
string Description [get]
 Gets the description from the subclass's PluginAttribute. More...
 
string Instructions [get]
 Gets the instructions from the subclass's PluginAttribute. More...
 
Descriptor [get]
 Gets the descriptor so it can be serialized to remote clients.. More...
 
Attribute [get]
 Gets the attribute, lazy loads it as necessary. More...
 
- Properties inherited from Apac.Data.IMeasurementFormula
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...
 

Constructor & Destructor Documentation

◆ DiscretizationFormula()

Apac.Plugins.Formulae.DiscretizationFormula.DiscretizationFormula ( )
inline

Initializes a new instance of the DiscretizationFormula class.

Member Function Documentation

◆ OnProcessMeasurement()

override decimal Apac.Plugins.Formulae.DiscretizationFormula.OnProcessMeasurement ( Monitoring.Measurement  measurement,
decimal  resolution,
Settings.Configuration  config 
)
inlineprotected

This routine converts the raw reading into a discrete value based on the other inputs which control the threshold values. The threshold values define ranges of continuous values and their associated discrete values. This can be specialized to do binarization of values by supplying the minimum set of inputs with the discrete values being zero (0) and (1). This is not a thresholding operation, but a way to take a stream of data that has continous values and normalize them into discrete values.

Parameters
measurementThe measurement being processed.
resolutionThe resolution of the incoming data.
Returns
Returns a discrete value based on the inputs for the continuous thresholds and the corresponding discrete values (see the formula input descriptors for details).

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