Skip to main content

StreamDataEntity

Namespace: Meshmakers.Octo.Runtime.Contracts.StreamData

Base class for stream-data entity projections. Mirrors RtEntity for the time-series domain — typed properties for the captured attributes plus the built-in stream fields (StreamDataEntity.Timestamp, StreamDataEntity.RtId, StreamDataEntity.CkTypeId, StreamDataEntity.RtWellKnownName, StreamDataEntity.RtCreationDateTime, StreamDataEntity.RtChangedDateTime).

public class StreamDataEntity : RtTypeWithAttributes

Inheritance ObjectRtTypeWithAttributesStreamDataEntity

Properties

RtId

Runtime id of the entity this data point belongs to.

public OctoObjectId RtId { get; set; }

Property Value

OctoObjectId

CkTypeId

Construction kit type id of the entity this data point belongs to.

public RtCkId<CkTypeId> CkTypeId { get; set; }

Property Value

RtCkId<CkTypeId>

Timestamp

Timestamp of this data point (time-series position).

public DateTime Timestamp { get; set; }

Property Value

DateTime

RtWellKnownName

Well-known name of the source entity, if any.

public string RtWellKnownName { get; set; }

Property Value

String

RtCreationDateTime

When the source entity was originally created.

public Nullable<DateTime> RtCreationDateTime { get; set; }

Property Value

Nullable<DateTime>

RtChangedDateTime

When the source entity was last modified.

public Nullable<DateTime> RtChangedDateTime { get; set; }

Property Value

Nullable<DateTime>

Attributes

Returns a dictionary of attributes.

public IReadOnlyDictionary<string, object> Attributes { get; }

Property Value

IReadOnlyDictionary<String, Object>

Remarks:

Vor getting/setting values use the GetAttribute/SetAttribute-Methods

Constructors

StreamDataEntity()

Creates a new instance of StreamDataEntity.

public StreamDataEntity()

StreamDataEntity(IReadOnlyDictionary<String, Object>)

Creates a new instance of StreamDataEntity with the attribute bag pre-populated.

public StreamDataEntity(IReadOnlyDictionary<string, object> attributes)

Parameters

attributes IReadOnlyDictionary<String, Object>

Methods

GetLocation()

protected string GetLocation()

Returns

String