Interface HistoricalNode


public interface HistoricalNode
A versioned node in a historian: uniquely identified, with a source path, an optional data type, a creation time, and an optional retirement time.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns when the node was created.
    Returns the node's data type, or empty if it has none.
    id()
    Returns the node's identity within its historian, stable across restarts.
    Returns the interpolation hint the engine stored for the node when it was historized, or empty if the engine keeps none.
    default boolean
    isActiveAt(Instant timestamp)
    Whether this version was active at timestamp: the time is on or after creation and before retirement, if any.
    default boolean
    Whether this version has no retirement time.
    Returns when the node was retired, or empty if it has not been.
    Returns the path of the node's source.
  • Method Details

    • id

      Returns the node's identity within its historian, stable across restarts. Federated queries identify nodes by source(); this id is internal to the historian.
    • source

      QualifiedPath source()
      Returns the path of the node's source.
    • dataType

      Optional<DataType> dataType()
      Returns the node's data type, or empty if it has none.
    • interpolationMode

      default Optional<InterpolationMode> interpolationMode()
      Returns the interpolation hint the engine stored for the node when it was historized, or empty if the engine keeps none. When present it takes precedence over the data-type default (floating point linear, everything else previous) for the query pipeline's AUTO fill.
    • createdTime

      Instant createdTime()
      Returns when the node was created.
    • retiredTime

      Optional<Instant> retiredTime()
      Returns when the node was retired, or empty if it has not been.
    • isActiveAt

      default boolean isActiveAt(Instant timestamp)
      Whether this version was active at timestamp: the time is on or after creation and before retirement, if any. Pure over the node's state, so safe from any thread.
      Parameters:
      timestamp - the point in time; not null
    • isCurrentlyActive

      default boolean isCurrentlyActive()
      Whether this version has no retirement time. Pure over the node's state, so safe from any thread.