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

Interface AtomicPoint<V>

Type Parameters:

V - The type of the value contained in the atomic point.

All Superinterfaces:

Comparable<TemporalPoint<V,DataPointType>>, DataPoint<V>, SnapshotCapable, TemporalPoint<V,DataPointType>

public sealed interface AtomicPoint<V>
extends DataPoint<V>

Represents an atomic data point in the historian system.

This sealed interface extends DataPoint with a value type V and is restricted to the DataPointFactory.AtomicPointImpl implementation. It provides methods to retrieve the type of the data point and to create snapshots with or without a specified timestamp.

Method Summary

Modifier and Type	Method	Description
default DataPointType	type()	Retrieves the type of the atomic point.
default AtomicPoint<V>	withSnapshot()	Creates a snapshot of the atomic point with the current timestamp.
AtomicPoint<V>	withSnapshot(Instant timestamp)	Creates a snapshot of the atomic point with the specified timestamp.

Methods inherited from interface com.inductiveautomation.historian.common.model.data.DataPoint

quality, value, valueClass

Methods inherited from interface com.inductiveautomation.historian.common.model.data.SnapshotCapable

isSnapshot, snapshotTimestamp

Methods inherited from interface com.inductiveautomation.historian.common.model.data.TemporalPoint

compareTo, source, timestamp

Method Details

type

default DataPointType type()

Retrieves the type of the atomic point.

By default, this method returns StandardDataPointType.ATOMIC.

Specified by:

type in interface DataPoint<V>

Specified by:

type in interface TemporalPoint<V,DataPointType>

Returns:

The type of the atomic point.

withSnapshot

default AtomicPoint<V> withSnapshot()

Creates a snapshot of the atomic point with the current timestamp.

Specified by:

withSnapshot in interface SnapshotCapable

Returns:

A new AtomicPoint instance with the current timestamp as the snapshot.

withSnapshot

AtomicPoint<V> withSnapshot(Instant timestamp)

Creates a snapshot of the atomic point with the specified timestamp.

Specified by:

withSnapshot in interface SnapshotCapable

Parameters:

timestamp - The Instant representing the snapshot timestamp.

Returns:

A new AtomicPoint instance with the specified timestamp as the snapshot.