Constructor.
the stream ID
the time zone ID
the stream type
the node or location ID
the source ID
Optional
iNames: string[]the instantaneous property name array
Optional
aNames: string[]the accumulating property name array
Optional
sNames: string[]the status property name array
Private
Optional
#aPrivate
Optional
#iPrivate
#kindPrivate
#objectPrivate
Optional
#sPrivate
#sourcePrivate
#streamPrivate
#zoneThe accumulating property names array length.
The accumulating property names array.
The instantaneous property names array length.
The instantaneous property names array.
The stream type.
The stream object ID (if the kind
is Location
), otherewise undefined
.
The stream object ID (if the kind
is Node
), otherwise undefined
.
The stream objece (node or location) ID.
Get all stream property names, in order of instantaneous, accumulating, and status.
The total number of instantaneous, accumulating, and status property names.
The stream source ID.
The status property names array length.
The status property names array.
The stream ID, for example 7714f762-2361-4ec2-98ab-7e96807b32a6
.
The stream time zone ID, for example Pacific/Auckland
.
Get the property names for a given samples type.
the type of property names to return; Tag
is not supported
the property names for the given type, or undefined
if none available
Get this object as a standard JSON encoded string value.
An example result looks like this:
{
"streamId": "7714f762-2361-4ec2-98ab-7e96807b32a6",
"zone": "Pacific/Auckland",
"kind": "n",
"objectId": 123,
"sourceId": "/power/1",
"i": ["watts", "current", "voltage", "frequency"],
"a": ["wattHours"]
}
the JSON encoded string
Static
fromParse a JSON string into a Domain.DatumStreamMetadata instance.
The JSON must be encoded the same way Domain.DatumStreamMetadata#toJsonEncoding does.
the JSON to parse
the stream metadata instance
Static
fromCreate a metadata instance from an object parsed from a JSON string.
The object must have been parsed from JSON that was encoded the same way Domain.DatumStreamMetadata#toJsonEncoding does.
the object parsed from JSON
the stream metadata instance
Static
locationCreate a new location datum stream metadata instance.
the stream ID
the time zone ID
the location ID
the source ID
Optional
iNames: string[]the instantaneous property name array
Optional
aNames: string[]the accumulating property name array
Optional
sNames: string[]the status property name array
the new metadata instance
Static
nodeCreate a new node datum stream metadata instance.
the stream ID
the time zone ID
the node ID
the source ID
Optional
iNames: string[]the instantaneous property name array
Optional
aNames: string[]the accumulating property name array
Optional
sNames: string[]the status property name array
the new metadata instance
Generated using TypeDoc
Metadata about a datum stream.