Record Class AggregateFunction.Window
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.AggregateFunction.Window
- Enclosing interface:
AggregateFunction<ACC>
public static record AggregateFunction.Window(long startMs, long endMs, @Nullable AggregateFunction.PriorSample prior, QualityLevelFilter admit, boolean sloped)
extends Record
The window a fold opens: its bounds in epoch milliseconds (
[startMs, endMs), the end
clipped to the query range), the sample in effect at its start when one is known, the levels
the query's quality filter admits, and whether the signal ramps linearly between samples
(sloped) or holds each value until the next.-
Constructor Summary
ConstructorsConstructorDescriptionWindow(long startMs, long endMs, @Nullable AggregateFunction.PriorSample prior, QualityLevelFilter admit, boolean sloped) Creates an instance of aWindowrecord class. -
Method Summary
Modifier and TypeMethodDescriptionadmit()Returns the value of theadmitrecord component.booleanbounded()Whether the window has bounds a time integral can cover.longendMs()Returns the value of theendMsrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@Nullable AggregateFunction.PriorSampleprior()Returns the value of thepriorrecord component.booleansloped()Returns the value of theslopedrecord component.longstartMs()Returns the value of thestartMsrecord component.final StringtoString()Returns a string representation of this record class.static AggregateFunction.Windowunbounded(QualityLevelFilter admit) No bounds, no prior, stepped, admitting byadmit: the raw and event-driven folds.
-
Constructor Details
-
Window
public Window(long startMs, long endMs, @Nullable AggregateFunction.PriorSample prior, QualityLevelFilter admit, boolean sloped) Creates an instance of aWindowrecord class.- Parameters:
startMs- the value for thestartMsrecord componentendMs- the value for theendMsrecord componentprior- the value for thepriorrecord componentadmit- the value for theadmitrecord componentsloped- the value for theslopedrecord component
-
-
Method Details
-
unbounded
No bounds, no prior, stepped, admitting byadmit: the raw and event-driven folds. -
bounded
public boolean bounded()Whether the window has bounds a time integral can cover. -
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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
startMs
public long startMs()Returns the value of thestartMsrecord component.- Returns:
- the value of the
startMsrecord component
-
endMs
public long endMs()Returns the value of theendMsrecord component.- Returns:
- the value of the
endMsrecord component
-
prior
Returns the value of thepriorrecord component.- Returns:
- the value of the
priorrecord component
-
admit
Returns the value of theadmitrecord component.- Returns:
- the value of the
admitrecord component
-
sloped
public boolean sloped()Returns the value of theslopedrecord component.- Returns:
- the value of the
slopedrecord component
-