Record Class PersistentComplexPoint

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storeforward.data.PersistentComplexPoint
Record Components:
point - the complex point carried.
All Implemented Interfaces:
PersistentPoint, PersistentData

public record PersistentComplexPoint(@NonNull ComplexPoint<?> point) extends Record implements PersistentPoint
Store & Forward carrier for one ComplexPoint, a metadata or annotation point. Like PersistentAtomicPoint, it is engine-neutral; PersistentComplexPointSerializer packs it into the generic common.protobuf.ComplexPointPB wire format.
Since:
2027.02
  • Field Details

  • Constructor Details

    • PersistentComplexPoint

      public PersistentComplexPoint(@NonNull ComplexPoint<?> point)
      Creates an instance of a PersistentComplexPoint record class.
      Parameters:
      point - the value for the point record component
  • Method Details

    • getFlavor

      public @NonNull PersistentFlavor<PersistentComplexPoint> getFlavor()
      Description copied from interface: PersistentData
      Retrieves the PersistentFlavor associated with this kind of persistent data.
      Specified by:
      getFlavor in interface PersistentData
      Specified by:
      getFlavor in interface PersistentPoint
      Returns:
      a PersistentFlavor object
    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • point

      public @NonNull ComplexPoint<?> point()
      Returns the value of the point record component.
      Returns:
      the value of the point record component