Record Class AggregateFunction.PriorSample

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.AggregateFunction.PriorSample
Record Components:
tsMs - the sample's timestamp in epoch milliseconds, on the same clock as AggregateFunction.Window.
Enclosing interface:
AggregateFunction<ACC>

public static record AggregateFunction.PriorSample(long tsMs, @Nullable Object value, @Nullable QualityCode quality) extends Record
A sample outside a window that bounds it: the latest sample strictly before the window start (a bounding seed before the query range or the last sample of an earlier window), or the first sample at or after its end.
  • Constructor Summary

    Constructors
    Constructor
    Description
    PriorSample(long tsMs, @Nullable Object value, @Nullable QualityCode quality)
    Creates an instance of a PriorSample record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    @Nullable QualityCode
    Returns the value of the quality record component.
    final String
    Returns a string representation of this record class.
    long
    Returns the value of the tsMs record component.
    @Nullable Object
    Returns the value of the value record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • PriorSample

      public PriorSample(long tsMs, @Nullable Object value, @Nullable QualityCode quality)
      Creates an instance of a PriorSample record class.
      Parameters:
      tsMs - the value for the tsMs record component
      value - the value for the value record component
      quality - the value for the quality record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      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 with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • tsMs

      public long tsMs()
      Returns the value of the tsMs record component.
      Returns:
      the value of the tsMs record component
    • value

      public @Nullable Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component
    • quality

      public @Nullable QualityCode quality()
      Returns the value of the quality record component.
      Returns:
      the value of the quality record component