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

Interface DataPoint<V>

Type Parameters:
V - The type of the value contained in the data point.
All Superinterfaces:
Comparable<TemporalPoint<V,DataPointType>>, SnapshotCapable, TemporalPoint<V,DataPointType>
All Known Subinterfaces:
AggregatedPoint<V,A>, AtomicPoint<V>
All Known Implementing Classes:
AggregatedDataPoint
public sealed interface DataPoint<V> extends SnapshotCapable, TemporalPoint<V,DataPointType> permits AggregatedPoint<V,A>, AtomicPoint<V>
Represents a data point in the historian system.

This sealed interface defines the structure and behavior of a data point, which can either be an AggregatedPoint or an AtomicPoint. It extends SnapshotCapable and TemporalPoint to provide snapshot and temporal capabilities.

  • Method Details

    • value

      @Nullable V value()
      Retrieves the value of the data point.
      Specified by:
      value in interface TemporalPoint<V,DataPointType>
      Returns:
      The value of the data point, or null if not set.

    • type

      default DataPointType type()
      Retrieves the type of the data point.

      By default, this method returns StandardDataPointType.GENERIC.

      Specified by:
      type in interface TemporalPoint<V,DataPointType>
      Returns:
      The type of the data point.

    • quality

      QualityCode quality()
      Retrieves the quality code of the data point.
      Returns:
      The quality code of the data point.

    • valueClass

      default Optional<Class<V>> valueClass()
      Retrieves the class of the value type.

      If the value is null, an empty Optional is returned. Otherwise, the class of the value is wrapped in an Optional.

      Returns:
      An Optional containing the class of the value type, or empty if the value is null.