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 TypeMethodDescriptionReturns when the node was created.dataType()Returns the node's data type, or empty if it has none.id()Returns the node's identity within its historian, stable across restarts.default Optional<InterpolationMode> Returns the interpolation hint the engine stored for the node when it was historized, or empty if the engine keeps none.default booleanisActiveAt(Instant timestamp) Whether this version was active attimestamp: the time is on or after creation and before retirement, if any.default booleanWhether this version has no retirement time.Returns when the node was retired, or empty if it has not been.source()Returns the path of the node's source.
-
Method Details
-
id
HistoricalNodeId id()Returns the node's identity within its historian, stable across restarts. Federated queries identify nodes bysource(); this id is internal to the historian. -
source
QualifiedPath source()Returns the path of the node's source. -
dataType
-
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'sAUTOfill. -
createdTime
Instant createdTime()Returns when the node was created. -
retiredTime
-
isActiveAt
Whether this version was active attimestamp: 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.
-