ElevatorControlTrait.ElevatorFloor
class ElevatorControlTrait.ElevatorFloor : ClusterStruct
An elevator floor.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
ElevatorFloor(Creates the ElevatorFloor class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
String |
The internal name of the elevator floor which is used in commands. |
List<ElevatorControlTrait.FloorNameSynonym> |
Synonyms for this floor in each supported language. |
Public constructors
ElevatorFloor
ElevatorFloor(
floorName: String = "",
floorNameSynonyms: List<ElevatorControlTrait.FloorNameSynonym> = emptyList()
)
Creates the ElevatorFloor class.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
floorName
val floorName: String
The internal name of the elevator floor which is used in commands. This name is shared across all languages. This name must also be included in the synonyms list if it is a valid name for the floor.
floorNameSynonyms
val floorNameSynonyms: List<ElevatorControlTrait.FloorNameSynonym>
Synonyms for this floor in each supported language.