SolarNetwork Core

Class: AggregateDatum

domain~ AggregateDatum

A concrete StreamDatumMetadataMixin of StreamAggregateDatum.

new AggregateDatum()

Extends:
Mixes In:

Extends

Methods

toJsonEncoding( [registry])

Get this object as a standard JSON encoded string value.

This method returns the JSON form of the result of StreamAggregateDatum#toJsonObject().

Parameters:
Name Type Argument Description
registry module:util~DatumStreamMetadataRegistry <optional>

a stream metadata registry to encode as a registry-indexed stream datum
Inherited From:
Returns:

the JSON encoded string

Type
string

toJsonObject( [registry])

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,[1650945600000,1651032000000],[3.6,2,0,7.2],[19.1,2,18.1, 20.1],[1.422802,1138.446687,1139.869489]]

while without a registry the array might look like this:

["7714f762-2361-4ec2-98ab-7e96807b32a6", [1650945600000,1651032000000],[3.6,2,0,7.2],[19.1,2,18.1, 20.1],[1.422802,1138.446687,1139.869489]]
Parameters:
Name Type Argument Description
registry module:util~DatumStreamMetadataRegistry <optional>

a stream metadata registry to encode as a registry-indexed stream datum
Inherited From:
Returns:

the datum stream array object

Type
Array

toObject(meta [, withoutStatistics])

Get this instance as a simple object.

The following basic properties will be set on the returned object:

  • streamId - the stream ID
  • date - the timestamp
  • date_end - the ending timestamp, if available
  • sourceId - the metadata source ID
  • nodeId or locationId - either the node ID or location ID from the metadata
  • tags - 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. Any available statistics for each property are included as well, using property names with the following suffixes:

  • _count - count of datum
  • _min - minimum value
  • _max - maximum value
  • _start - starting value
  • _end - ending value
Parameters:
Name Type Argument Description
meta module:domain~DatumStreamMetadata

a metadata instance to encode the property names with
withoutStatistics boolean <optional>

{@literal true} to omit statistic properties
Inherited From:
Returns:

an object populated with all available properties

Type
Object