VMMSBaseBuilding

Objective-C

@interface VMMSBaseBuilding : NSObject

Swift

class VMMSBaseBuilding : NSObject

Class that contains information for a building within a venue. Encapsulates floors (VMMSBaseFloor) that are in this building.

Since

1.1

Initializers

  • Initializer to use if building does not have a name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBuildingId:(nonnull NSString *)uid;

    Swift

    init(buildingId uid: String)

    Parameters

    uid

    ID of the building.

    Return Value

    A VMMSBaseBuilding instance.

  • Initializer to use if the building does have a name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBuildingId:(nonnull NSString *)uid
                           andBuildingName:(nonnull NSString *)name;

    Swift

    init(buildingId uid: String, andBuildingName name: String)

    Parameters

    uid

    ID of the building.
    name

    Name of the building.

    Return Value

    A VMMSBaseBuilding instance.

Public Methods

Public Properties

  • uid

    Unique identifier of the building.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull uid;

    Swift

    var uid: String { get set }

  • Identifies the building ordinal value

    Since

    1.2

    Declaration

    Objective-C

    @property (nonatomic) NSInteger buildingNumber;

    Swift

    var buildingNumber: Int { get set }

  • Display name of the building.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull name;

    Swift

    var name: String { get set }

  • UUID for building.

    Since

    2.0

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull placeId;

    Swift

    var placeId: String { get set }

  • The coordinates that make up the perimeter

    Since

    1.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSArray<NSValue *> *> *_Nonnull coordinates;

    Swift

    var coordinates: [[NSValue]] { get set }

  • The geojson coordinates for this geeojson feature representing this floor

    Since

    1.3.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray *_Nonnull geojsonCoordinates;

    Swift

    var geojsonCoordinates: [Any] { get set }

  • The geojson geometry type

    Since

    1.3.1

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull geometryType;

    Swift

    var geometryType: String { get set }

  • Floors contained in this building

    Declaration

    Objective-C

    @property (nonatomic, strong) NSMutableDictionary<NSString *, VMMSBaseFloor *> *_Nonnull floors;

    Swift

    var floors: NSMutableDictionary { get set }

  • The center of the building, based on the coordinates from its shape

    Note

    This may be a weird location if the building is oddly shaped

    Since

    1.2

    Declaration

    Objective-C

    @property (nonatomic, readonly) CLLocationCoordinate2D centerLocation;

    Swift

    var centerLocation: CLLocationCoordinate2D { get }