ServiceAreaTrait.ProgressStruct
class ServiceAreaTrait.ProgressStruct : ClusterStruct
Data about the operating status of an area.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
ProgressStruct(Creates the ProgressStruct 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 |
|
|---|---|
UInt |
The identifier of the area, where the identifier is an entry in the |
OptionalValue<UInt?> |
The estimated time for the operation, in seconds, from when the device starts operating at the area indicated by the |
ServiceAreaTrait.OperationalStatusEnum |
The operational status of the device for the area, indicated by the |
OptionalValue<UInt?> |
The total operational time, in seconds, from when the device started to operate at the area indicated by the |
Public constructors
ProgressStruct
ProgressStruct(
areaId: UInt,
status: ServiceAreaTrait.OperationalStatusEnum = OperationalStatusEnum.Pending,
totalOperationalTime: OptionalValue<UInt?> = OptionalValue.absent(),
estimatedTime: OptionalValue<UInt?> = OptionalValue.absent()
)
Creates the ProgressStruct 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
areaId
val areaId: UInt
The identifier of the area, where the identifier is an entry in the supportedAreas attribute's list.
estimatedTime
val estimatedTime: OptionalValue<UInt?>
The estimated time for the operation, in seconds, from when the device starts operating at the area indicated by the areaID field until the operation completes, excluding any time spent while not operating in the area.
status
val status: ServiceAreaTrait.OperationalStatusEnum
The operational status of the device for the area, indicated by the areaID field.
totalOperationalTime
val totalOperationalTime: OptionalValue<UInt?>
The total operational time, in seconds, from when the device started to operate at the area indicated by the areaID field until the operation finished.