Record Class EngineDirective
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.EngineDirective
- Record Components:
gap- how the engine treats windows without samples.edges- the windows the engine returns edges for.shape-SLOPEDorSTEPPEDwhen the query forces the shape a time-weighted aggregate integrates over;AUTOleaves it to the engine: the tag's stored interpolation, else the stored values' type (floating point sloped, any other stepped).
public record EngineDirective(EngineDirective.GapPolicy gap, EngineDirective.EdgeRequest edges, Interpolation shape)
extends Record
What the gateway asks an engine to do for one aggregated key it computes natively: how to treat
windows without samples, which window edges to return, and the signal's shape between samples.
The gateway resolves both from the key's interpolation and fill and owns them; an engine sees
only the directive, never the interpolation or the fill word.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe windows the engine returns edges for: the first and last stored sample of each.static enumHow the engine treats a window without samples. -
Constructor Summary
ConstructorsConstructorDescriptionA directive that leaves the shape to the tag's stored interpolation.EngineDirective(EngineDirective.GapPolicy gap, EngineDirective.EdgeRequest edges, Interpolation shape) Creates an instance of aEngineDirectiverecord class. -
Method Summary
Modifier and TypeMethodDescriptionedges()Returns the value of theedgesrecord component.final booleanIndicates whether some other object is "equal to" this one.static EngineDirectiveforEdges(AggregationType type, DataType inputType, boolean readsWindowNotEdges, Interpolation shape) Resolves a directive for windows computed from bounds.static EngineDirectiveforWindows(FillMode requestedFill, FillMode resolvedFill, Interpolation shape) Resolves a directive for windows computed from their own samples.gap()Returns the value of thegaprecord component.final inthashCode()Returns a hash code value for this object.shape()Returns the value of theshaperecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
EngineDirective
public EngineDirective(EngineDirective.GapPolicy gap, EngineDirective.EdgeRequest edges, Interpolation shape) Creates an instance of aEngineDirectiverecord class. -
EngineDirective
A directive that leaves the shape to the tag's stored interpolation.
-
-
Method Details
-
forWindows
public static EngineDirective forWindows(FillMode requestedFill, FillMode resolvedFill, Interpolation shape) Resolves a directive for windows computed from their own samples.resolvedFillis the type-aware fill; a column that cannot ramp carries under a requestedLINEARfill, and Leave empty returns no row for a window without samples. -
forEdges
public static EngineDirective forEdges(AggregationType type, DataType inputType, boolean readsWindowNotEdges, Interpolation shape) Resolves a directive for windows computed from bounds.readsWindowNotEdgesidentifies a window-aware fold that does not consume each row's edges. -
toString
-
hashCode
-
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object). -
gap
-
edges
-
shape
-