Console

LocationDescriptorStruct 

struct LocationDescriptorStruct

Data describing the location of an area.

  • The name of the area. A value of null indicates that the area name is unknown.

    Declaration

    Swift

    let locationName: String

  • The floor number of the area. A value of null indicates that the floor number is not available or known.

    Declaration

    Swift

    let floorNumber: Int16?

  • The type of the area. A value of null indicates that the area type is not available or known.

    Declaration

    Swift

    let areaType: UInt8?

  • Creates a new Struct instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder) throws

    Parameters

    decoder

    The raw data representing this Struct.

  • Writes this Struct to the given TraitEncoder. Throws HomeError.parseError if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns the field corresponding to the given field ID.

    Declaration

    Swift

    static func structField(id: UInt32) -> (any Field)?