ElectricalPowerMeasurementTrait.MeasurementRangeStruct

class ElectricalPowerMeasurementTrait.MeasurementRangeStruct : ClusterStruct

The maximum and minimum values of a given measurement type during a measurement period, along with the observation times of these values.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors
MeasurementRangeStruct(
    measurementType: ElectricalPowerMeasurementTrait.MeasurementTypeEnum,
    min: Long,
    max: Long,
    startTimestamp: OptionalValue<UInt>,
    endTimestamp: OptionalValue<UInt>,
    minTimestamp: OptionalValue<UInt>,
    maxTimestamp: OptionalValue<UInt>,
    startSystime: OptionalValue<ULong>,
    endSystime: OptionalValue<ULong>,
    minSystime: OptionalValue<ULong>,
    maxSystime: OptionalValue<ULong>
)

Creates the MeasurementRangeStruct class.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
OptionalValue<ULong>

The time, in milliseconds, since boot at the end of the measurement period.
OptionalValue<UInt>

The timestamp in UTC of the end of the measurement period.
Long

The largest measured value for the associated measurement over the period between either startTimestamp and endTimestamp or the period between startSystime and endSystime, or both.
OptionalValue<ULong>

The measurement time, in milliseconds, since boot of the value in the max field.
OptionalValue<UInt>

The most recent timestamp in UTC of the value in the max field.
ElectricalPowerMeasurementTrait.MeasurementTypeEnum

The measurement type for the range provided.
Long

The smallest measured value for the associated measurement over the period between either startTimestamp and endTimestamp or the period between startSystime and endSystime, or both.
OptionalValue<ULong>

The measurement time, in milliseconds, since boot of the value in the min field.
OptionalValue<UInt>

The most recent timestamp in UTC of the value in the min field. greater than or equal to the value of the startTimestamp field, and less than or equal to the value of the endTimestamp field.
OptionalValue<ULong>

The time since boot at the start of the measurement period.
OptionalValue<UInt>

The timestamp in UTC of the start of the measurement period.

Public constructors

MeasurementRangeStruct

MeasurementRangeStruct(
    measurementType: ElectricalPowerMeasurementTrait.MeasurementTypeEnum = MeasurementTypeEnum.Unspecified,
    min: Long = 0,
    max: Long = 0,
    startTimestamp: OptionalValue<UInt> = OptionalValue.absent(),
    endTimestamp: OptionalValue<UInt> = OptionalValue.absent(),
    minTimestamp: OptionalValue<UInt> = OptionalValue.absent(),
    maxTimestamp: OptionalValue<UInt> = OptionalValue.absent(),
    startSystime: OptionalValue<ULong> = OptionalValue.absent(),
    endSystime: OptionalValue<ULong> = OptionalValue.absent(),
    minSystime: OptionalValue<ULong> = OptionalValue.absent(),
    maxSystime: OptionalValue<ULong> = OptionalValue.absent()
)

Creates the MeasurementRangeStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

endSystime

val endSystime: OptionalValue<ULong>

The time, in milliseconds, since boot at the end of the measurement period.

endTimestamp

val endTimestamp: OptionalValue<UInt>

The timestamp in UTC of the end of the measurement period.

max

val max: Long

The largest measured value for the associated measurement over the period between either startTimestamp and endTimestamp or the period between startSystime and endSystime, or both.

maxSystime

val maxSystime: OptionalValue<ULong>

The measurement time, in milliseconds, since boot of the value in the max field. The value is greater than or equal to the value of the startSystime field and less than or equal to the value of the endSystime field.

maxTimestamp

val maxTimestamp: OptionalValue<UInt>

The most recent timestamp in UTC of the value in the max field. The value is greater than or equal to the value of the startTimestamp field, and less than or equal to the value of the endTimestamp field.

measurementType

val measurementType: ElectricalPowerMeasurementTrait.MeasurementTypeEnum

The measurement type for the range provided.

min

val min: Long

The smallest measured value for the associated measurement over the period between either startTimestamp and endTimestamp or the period between startSystime and endSystime, or both.

minSystime

val minSystime: OptionalValue<ULong>

The measurement time, in milliseconds, since boot of the value in the min field. The value is greater than or equal to the value of the startSystime field andless than or equal to the value of the endSystime field.

minTimestamp

val minTimestamp: OptionalValue<UInt>

The most recent timestamp in UTC of the value in the min field. greater than or equal to the value of the startTimestamp field, and less than or equal to the value of the endTimestamp field.

startSystime

val startSystime: OptionalValue<ULong>

The time since boot at the start of the measurement period.

startTimestamp

val startTimestamp: OptionalValue<UInt>

The timestamp in UTC of the start of the measurement period.