OvenCavityOperationalStateTrait.OperationalStateStruct

class OvenCavityOperationalStateTrait.OperationalStateStruct : ClusterStruct

Used to indicate a possible state of the oven.

Summary

Public constructors
OperationalStateStruct(
    operationalStateId: UByte,
    operationalStateLabel: OptionalValue<String>
)

Creates the OperationalStateStruct 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
UByte
OptionalValue<String>

A human-readable description of the operational state.

Public constructors

OperationalStateStruct

OperationalStateStruct(
    operationalStateId: UByte,
    operationalStateLabel: OptionalValue<String> = OptionalValue.absent()
)

Creates the OperationalStateStruct class.

Public functions

getDescriptor

open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

open fun getFieldValueById(tagId: UInt): Any?

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

Public properties

operationalStateId

val operationalStateId: UByte

operationalStateLabel

val operationalStateLabel: OptionalValue<String>

A human-readable description of the operational state. Only present when the operationalStateId is vendor-specific.