ServiceAreaTrait.LocationDescriptorStruct
class ServiceAreaTrait.LocationDescriptorStruct : ClusterStruct
Data describing the location of an area.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
LocationDescriptorStruct(Creates the LocationDescriptorStruct 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? |
The type of the area. |
Short? |
The floor number of the area. |
String |
The name of the area. |
Public constructors
LocationDescriptorStruct
LocationDescriptorStruct(
locationName: String = "",
floorNumber: Short? = null,
areaType: UByte? = null
)
Creates the LocationDescriptorStruct 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
areaType
val areaType: UByte?
The type of the area. A value of null indicates that the area type is not available or known.
floorNumber
val floorNumber: Short?
The floor number of the area. A value of null indicates that the floor number is not available or known.
locationName
val locationName: String
The name of the area. A value of null indicates that the area name is unknown.