Constructor
new StreamDatum(streamId, ts, iPropsopt, aPropsopt, sPropsopt, tagsopt)
Constructor.
| Name | Type | Attributes | Description |
|---|---|---|---|
streamId | string | the datum stream ID | |
ts | Date | | the datum timestamp, either as a | |
iProps | Array.<Number> | <optional> | the instantaneous property values |
aProps | Array.<Number> | <optional> | the accumulating property values |
sProps | Array.<String> | <optional> | the status property values |
tags | Set.<String> | | <optional> | the tag values |
- Source
Methods
propertyValuesForType(samplesType) → {Array}
Get the property values for a given samples type.
| Name | Type | Description |
|---|---|---|
samplesType | module:domain~DatumSamplesType | the type of property values to return |
- Source
the property values for the given type, or undefined if none available
- Type:
- Array
toJsonEncoding(registryopt) → {string}
Get this object as a standard JSON encoded string value.
This method returns the JSON form of the result of StreamDatum#toJsonObject().
| Name | Type | Attributes | Description |
|---|---|---|---|
registry | module:util~DatumStreamMetadataRegistry | <optional> | a stream metadata registry to encode as a registry-indexed stream datum |
- Source
the JSON encoded string
- Type:
- string
toJsonObject(registryopt) → {Array}
Get this object as an array suitable for encoding into a standard stream datum JSON string.
This method can encode the datum into an array using one of two ways, depending on whether the registry argument is provided. When provided, the first array element will be the stream metadata index based on calling DatumStreamMetadataRegistry#indexOfMetadataStreamId(). Otherwise the first array element will be the stream ID itself.
For example if a registry is used, the resulting array might look like this:
[0, 1650667326308, 12326, null, 230.19719, 50.19501, 6472722]
while without a registry the array might look like this:
["7714f762-2361-4ec2-98ab-7e96807b32a6", 1650667326308, 12326, null, 230.19719, 50.19501, 6472722]
| Name | Type | Attributes | Description |
|---|---|---|---|
registry | module:util~DatumStreamMetadataRegistry | <optional> | a stream metadata registry to encode as a registry-indexed stream datum |
- Source
the datum stream array object
- Type:
- Array
toObject(meta) → {Object}
Get this instance as a simple object.
The following basic properties will be set on the returned object:
streamId- the stream IDdate- the timestampsourceId- the metadata source IDnodeIdorlocationId- either the node ID or location ID from the metadatatags- any tags (as an Array)
Beyond that, all instantaneous, accumulating, and status properties will be included. If duplicate property names exist between the different classifications, the first-available value will be used.
| Name | Type | Description |
|---|---|---|
meta | module:domain~DatumStreamMetadata | a metadata instance to encode the property names with |
- Source
an object populated with all available properties
- Type:
- Object
(static) fromJsonEncoding(json, meta) → {module:domain~StreamDatum}
Parse a JSON string into a StreamDatum instance.
The JSON must be encoded the same way StreamDatum#toJsonEncoding() does.
| Name | Type | Description |
|---|---|---|
json | string | the JSON to parse |
meta | module:domain~DatumStreamMetadata | | a metadata instance or metadata registry to decode with |
- Source
the stream datum instance
(static) fromJsonObject(data, meta) → {module:domain~StreamDatum}
Create a new StreamDatum instance from an array parsed from a stream datum JSON string.
The array must have been parsed from JSON that was encoded the same way StreamDatum#toJsonEncoding() does.
| Name | Type | Description |
|---|---|---|
data | Array | the array parsed from JSON |
meta | module:domain~DatumStreamMetadata | | a metadata instance or metadata registry to decode with |
- Source
the stream datum instance