ZoneManagementTrait.ZoneInformationStruct
class ZoneManagementTrait.ZoneInformationStruct : ClusterStruct
Encodes basic information about a zone without containing the specifics of how the zone is defined.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
ZoneInformationStruct(Creates the ZoneInformationStruct 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 |
|
|---|---|
OptionalValue<ZoneManagementTrait.TwoDCartesianZoneStruct> |
Detailed information for the |
UShort |
Unique ZoneID of the zone. |
ZoneManagementTrait.ZoneSourceEnum |
The |
ZoneManagementTrait.ZoneTypeEnum |
A |
Public constructors
ZoneInformationStruct
ZoneInformationStruct(
zoneId: UShort,
zoneType: ZoneManagementTrait.ZoneTypeEnum = ZoneTypeEnum.TwoDCARTZone,
zoneSource: ZoneManagementTrait.ZoneSourceEnum = ZoneSourceEnum.Mfg,
twoDCartesianZone: OptionalValue<ZoneManagementTrait.TwoDCartesianZoneStruct> = OptionalValue.absent()
)
Creates the ZoneInformationStruct 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
twoDCartesianZone
val twoDCartesianZone: OptionalValue<ZoneManagementTrait.TwoDCartesianZoneStruct>
Detailed information for the TwoDCartesianZone.
zoneSource
val zoneSource: ZoneManagementTrait.ZoneSourceEnum
The ZoneSourceEnum value representing the source of the zone.
zoneType
val zoneType: ZoneManagementTrait.ZoneTypeEnum
A ZoneTypeEnum value representing the type of the zone.