Package com.inductiveautomation.historian.common.model.data

Interface TemporalPoint<V,T extends TemporalPointType>

Type Parameters:
V - The type of the value associated with the temporal point.
T - The type of the temporal point, extending TemporalPointType.
All Superinterfaces:
Comparable<TemporalPoint<V,T>>
All Known Subinterfaces:
AggregatedPoint<V,A>, AtomicPoint<V>, ChangePoint<V>, ComplexPoint<V>, DataPoint<V>
All Known Implementing Classes:
AggregatedDataPoint, AnnotationChangePoint, AnnotationPoint, MetadataPoint, SourceChangePoint
public sealed interface TemporalPoint<V,T extends TemporalPointType> extends Comparable<TemporalPoint<V,T>> permits ChangePoint<V>, ComplexPoint<V>, DataPoint<V>
Represents a temporal point in the historian system.

This sealed interface defines the contract for temporal points, which are comparable based on their timestamps. It restricts its implementations to specific subtypes: ChangePoint, ComplexPoint, and DataPoint.

  • Method Summary

    Modifier and Type
    Method
    Description
    default int
    compareTo(@NotNull TemporalPoint<V,T> other)
    Compares this temporal point to another based on their timestamps.
    QualifiedPath
    source()
    Retrieves the source of the temporal point as a QualifiedPath.
    Instant
    timestamp()
    Retrieves the timestamp of the temporal point.
    T
    type()
    Retrieves the type of the temporal point.
    V
    value()
    Retrieves the value associated with the temporal point.

  • Method Details

    • value

      V value()
      Retrieves the value associated with the temporal point.
      Returns:
      The value of the temporal point.

    • timestamp

      Instant timestamp()
      Retrieves the timestamp of the temporal point.
      Returns:
      The timestamp of the temporal point.

    • source

      QualifiedPath source()
      Retrieves the source of the temporal point as a QualifiedPath.
      Returns:
      The source of the temporal point.

    • type

      T type()
      Retrieves the type of the temporal point.
      Returns:
      The type of the temporal point.

    • compareTo

      default int compareTo(@NotNull @NotNull TemporalPoint<V,T> other)
      Compares this temporal point to another based on their timestamps.
      Specified by:
      compareTo in interface Comparable<V>
      Parameters:
      other - The other temporal point to compare to.
      Returns:
      A negative integer, zero, or a positive integer as this temporal point's timestamp is earlier than, equal to, or later than the other temporal point's timestamp.