Classes
- AggregateDatum
- Aggregation
- AuthTokenStatus
- AuthTokenType
- CombiningType
- Datum
- DatumAuxiliaryType
- DatumFilter
- DatumReadingType
- DatumSamplesType
- DatumStreamMetadata
- DatumStreamType
- DeviceOperatingState
- GeneralMetadata
- InstructionState
- Location
- LocationPrecision
- Pagination
- SecurityPolicy
- SecurityPolicyBuilder
- SkyCondition
- SortDescriptor
- StreamAggregateDatum
- StreamDatum
- UserMetadataFilter
Mixins
Members
-
<inner, constant> Aggregations :module:domain~Aggregation
-
The enumeration of supported Aggregation values.
Type:
Properties:
Name Type Description Minutemodule:domain~Aggregation minute
FiveMinutemodule:domain~Aggregation 5 minutes
TenMinutemodule:domain~Aggregation 10 minutes
FifeteenMinutemodule:domain~Aggregation 15 minutes
ThirtyMinutemodule:domain~Aggregation 30 minutes
Hourmodule:domain~Aggregation an hour
HourOfDaymodule:domain~Aggregation an hour of a day, e.g. 1-24
SeasonalHourOfDaymodule:domain~Aggregation an hour of a day, further grouped into 4 seasons
Daymodule:domain~Aggregation a day
DayOfWeekmodule:domain~Aggregation a day of the week, e.g. Monday - Sunday
SeasonalDayOfWeekmodule:domain~Aggregation a day of the week, further grouped into 4 seasons
Weekmodule:domain~Aggregation a week
WeekOfYearmodule:domain~Aggregation the week within a year, e.g. 1 - 52
Monthmodule:domain~Aggregation a month
Yearmodule:domain~Aggregation a year
RunningTotalmodule:domain~Aggregation a complete running total over a time span
-
<inner, constant> AuthTokenStatuses :module:domain~AuthTokenStatus
-
The enumeration of supported AuthTokenStatus values.
Type:
Properties:
Name Type Description Activemodule:domain~AuthTokenStatus the token is active and usable
Disabledmodule:domain~AuthTokenStatus the token is disabled and not usable
-
<inner, constant> AuthTokenTypes :module:domain~AuthTokenType
-
The enumeration of supported AuthTokenType values.
Type:
Properties:
Name Type Description ReadNodeDatamodule:domain~AuthTokenType a read-only token for reading SolarNode data
Usermodule:domain~AuthTokenType full access as the user that owns the token
-
<inner, constant> CombiningTypes :module:domain~CombiningType
-
The enumeration of supported CombiningType values.
Type:
Properties:
Name Type Description Averagemodule:domain~CombiningType average
Differencemodule:domain~CombiningType difference; note the order of mapped IDs is significant
Summodule:domain~CombiningType sum
-
<inner, constant> DatumAuxiliaryTypes :module:domain~DatumAuxiliaryType
-
The enumeration of supported DatumAuxiliaryType values.
Type:
Properties:
Name Type Description Resetmodule:domain~DatumAuxiliaryType reset
-
<inner, constant> DatumReadingTypes :module:domain~DatumReadingType
-
The enumeration of supported
DatumReadingTypevalues.Type:
Properties:
Name Type Description CalculatedAtmodule:domain~DatumReadingType Derive a single reading value based from one datum the nearest before a specific time and one the nearest after.
CalculatedAtDifferencemodule:domain~DatumReadingType Calculate the difference between two reading values on two dates, using the
CalcualtedAtstyle of deriving the start and end readings.Differencemodule:domain~DatumReadingType Find the difference between two datum that are nearest in time on or before two dates, without any limits on how near to those dates the datum are.
DifferenceWithinmodule:domain~DatumReadingType Find the difference between two datum that are nearest in time and within two dates.
NearestDifferencemodule:domain~DatumReadingType Find the difference between two datum that are nearest in time on or before two dates, constrained by a maximum time tolerance.
-
<inner, constant> DatumSamplesTypes :module:domain~DatumSamplesType
-
The enumeration of supported
DatumSamplesTypevalues.Type:
Properties:
Name Type Description Instantaneousmodule:domain~DatumSamplesType Instantaneous number property values.
Accumulatingmodule:domain~DatumSamplesType Accumulating meter-style number property values.
Statusmodule:domain~DatumSamplesType String status property values.
Tagmodule:domain~DatumSamplesType Arbitrary string names.
-
<inner, constant> DatumStreamType :module:domain~DatumStreamType
-
The enumeration of supported
DatumStreamTypevalues.Type:
Properties:
Name Type Description Nodemodule:domain~DatumStreamType A node-based datum stream.
Locationmodule:domain~DatumStreamType A location-based datum stream.
-
<inner, constant> DeviceOperatingStates :module:domain~DeviceOperatingState
-
The enumeration of supported DeviceOperatingState values.
Type:
Properties:
Name Type Description Unknownmodule:domain~DeviceOperatingState an unknown state
Normalmodule:domain~DeviceOperatingState normal operating state
Startingmodule:domain~DeviceOperatingState a startup/initializing state
Standbymodule:domain~DeviceOperatingState a standby/low power mode
Shutdownmodule:domain~DeviceOperatingState a shutdown/off state
Faultmodule:domain~DeviceOperatingState a faulty or error condition
Disabledmodule:domain~DeviceOperatingState a disabled state
Recoverymodule:domain~DeviceOperatingState a recovery state
Overridemodule:domain~DeviceOperatingState a manual or overridden state
-
<inner, constant> InstructionStates :module:domain~InstructionState
-
The enumeration of supported InstructionState values.
Type:
Properties:
Name Type Description Unknownmodule:domain~InstructionState an unknown state
Queuedmodule:domain~InstructionState the instruction has been received by SolarNet but not yet delivered to its destination
Receivedmodule:domain~InstructionState the instruction has been delivered to its destination but not yet acted upon
Executedmodule:domain~InstructionState the instruction is currently being acted upon
Declinedmodule:domain~InstructionState the destination has declined to execute the instruction, or the execution failed
Completedmodule:domain~InstructionState the destination has executed successfully
-
<inner, constant> LocationPrecisions :module:domain~LocationPrecision
-
The enumeration of supported LocationPrecision values.
Type:
Properties:
Name Type Description LatLongmodule:domain~LocationPrecision GPS coordinates
Blockmodule:domain~LocationPrecision a city block
Streetmodule:domain~LocationPrecision a street
PostalCodemodule:domain~LocationPrecision a postal code (or "zip code")
Localitymodule:domain~LocationPrecision a town or city
StateOrProvincemodule:domain~LocationPrecision a state or province
Regionmodule:domain~LocationPrecision a large region
TimeZonemodule:domain~LocationPrecision a time zone
Countrymodule:domain~LocationPrecision a country
-
<inner, constant> SkyConditions :module:domain~SkyCondition
-
The enumeration of supported SkyCondition values.
Type:
Properties:
Name Type Description Clearmodule:domain~SkyCondition clear sky
ScatteredCloudsmodule:domain~SkyCondition scattered/few clouds
Fogmodule:domain~SkyCondition fog
Drizzlemodule:domain~SkyCondition drizzle, light rain
ScatteredShowersmodule:domain~SkyCondition scattered/few showers
Showersmodule:domain~SkyCondition showers, light rain
Rainmodule:domain~SkyCondition rain
Hailmodule:domain~SkyCondition hail
ScatteredSnowmodule:domain~SkyCondition scattered/light snow
Snowmodule:domain~SkyCondition snow
Stormmodule:domain~SkyCondition storm
SevereStormmodule:domain~SkyCondition severe storm
Thundermodule:domain~SkyCondition thunder, lightning
Windymodule:domain~SkyCondition windy
Hazymodule:domain~SkyCondition hazy
Tornadomodule:domain~SkyCondition tornado
Hurricanemodule:domain~SkyCondition hurrican
Dustymodule:domain~SkyCondition dusty
Methods
-
<inner> objectToStringMap(obj)
-
Convert a simple object into a
Mapinstance.Property values that are themselves objects will be converted into
Mapinstances as well.Parameters:
Name Type Description objobject a simple object
- See:
-
- module:domain~stringMapToObject for the reverse conversion
Returns:
a Map with string keys; nested Map objects are also handled
- Type
- Map.<string, *>
-
<inner> stringMapToObject(strMap)
-
Convert a
Mapinto a simple object.The keys are assumed to be strings. Values that are themselves
Mapinstances will be converted to simple objects as well.Parameters:
Name Type Description strMapMap.<string, *> a Map with string keys; nested Map objects are also handled
- See:
-
- objectToStringMap for the reverse conversion
Returns:
a simple object
- Type
- object