Class EngineAggregates

java.lang.Object
com.inductiveautomation.historian.gateway.api.query.EngineAggregates

public final class EngineAggregates extends Object
Definitions two or more engines compute. An engine may bind them or ignore them; the catalog does not know they exist. A definition fixes what the id means across engines; the engine keeps the SQL, the columns it reduces and its required extension. define(String, DataType, boolean, boolean, boolean) builds an engine's own definition the same way.
  • Field Details

  • Method Details

    • define

      public static EngineAggregates.Definition define(String id, @Nullable DataType dataType, boolean takesWindowFill, boolean counter, boolean oneSampleIsSample)
      A definition under id, which must not be a StandardAggregates id: dataType the output type (null keeps the tag's), takesWindowFill whether an empty window may take its neighbours' values, counter whether an empty window counts zero (a count of samples, changes or values; anything read between samples, such as a delta or a rate, has no value there and takes the fill), oneSampleIsSample whether a window holding one sample has that sample's value.