OperationalStateTrait.OperationCompletion
interface OperationalStateTrait.OperationCompletion : ClusterStruct
This event is generated when the overall operation ends, successfully or otherwise.
Summary
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 |
|
|---|---|
UByte? |
Provides an indication of the state at the end of the operation. |
UInt? |
The total time spent in the paused state, in seconds. |
UInt? |
The total operational time, in seconds, from when the operation was started until the operation completed, including any time spent while paused. |
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
completionErrorCode
val completionErrorCode: UByte?
Provides an indication of the state at the end of the operation.
totalOperationalTime
val totalOperationalTime: UInt?
The total operational time, in seconds, from when the operation was started until the operation completed, including any time spent while paused.