Krill SDK/krill.zone.shared.krillapp.datapoint/DataPointMetaData

DataPointMetaData

@Serializable

data class DataPointMetaData(val name: String = "data-point-", val sourceId: String = "", val precision: Int = 2, val unit: String = "", val manualEntry: Boolean = true, val dataType: DataType = DataType.DOUBLE, val maxAge: Long = 0, val path: String = "", val error: String = "", val sources: List<NodeIdentity> = emptyList(), val snapshot: Snapshot = Snapshot(Clock.System.now().epochSeconds, 0.0), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for a DataPoint node.

Constructors

DataPointMetaData

constructor(name: String = "data-point-", sourceId: String = "", precision: Int = 2, unit: String = "", manualEntry: Boolean = true, dataType: DataType = DataType.DOUBLE, maxAge: Long = 0, path: String = "", error: String = "", sources: List<NodeIdentity> = emptyList(), snapshot: Snapshot = Snapshot(Clock.System.now().epochSeconds, 0.0), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, inputs: List<NodeIdentity> = emptyList())

Properties

dataType

val dataType: DataType

Drives interpretation of Snapshot.value; see DataType.

error

open override val error: String

Last known error message for this node, or empty string when healthy.

inputs

open override val inputs: List<NodeIdentity>

sets the nodes this node reads from to complete its work when invoked

invocationTriggers

open override val invocationTriggers: List<InvocationTrigger>

The set of InvocationTriggers configured to wake this node. The node processor checks the incoming event against this list before doing any work. An empty list means "never auto-fire" — only manual execution.

manualEntry

val manualEntry: Boolean

true when the user can type values into the editor — false for read-only sources.

maxAge

val maxAge: Long

Maximum age (epoch millis) of stored snapshots — 0 means keep forever.

name

val name: String

Display name; default uses an epoch-second suffix so freshly created points don't collide.

nodeAction

open override val nodeAction: NodeAction

The action this node performs when it fires. Defaults to NodeAction.EXECUTE on every concrete implementation so that deserialising a payload that predates this field yields the original behaviour unchanged.

path

val path: String

Optional path-like address for grouping points in the editor.

precision

val precision: Int

Number of decimal places the editor renders Snapshot.value with.

snapshot

open override val snapshot: Snapshot

Stores the last result of when this node was invoked and is a source of data

sourceId

val sourceId: String

Optional UUID of a node whose values this DataPoint mirrors — empty when the point is a primary source rather than a derived one.