VMMSBaseBuilding

@interface VMMSBaseBuilding : NSObject

Abstract class that contains information for a building within a venue. Encapsulates floors (VMMSMapBuildingFloor or VMMSMapOutdoorBuildingFloor) that are in this building.

Since

1.1

Warning

DO NOT instantiate objects of this type directly. Instead, use one of the concreate subclasses VMMMapBuildingFloor or VMMSMapOutdoorBuildingFloor.

Initializers

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

    Declaration

    Swift

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

    Parameters

    uid

    ID of the building.

    Return Value

    A VMMSBaseBuilding instance.

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

    Declaration

    Swift

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

    Parameters

    uid

    ID of the building.
    name

    Name of the building.

    Return Value

    A VMMSBaseBuilding instance.

Public Methods

  • Adds a floor to this building.

    Declaration

    Swift

    - (void)addFloor:(VMMSBaseFloor *)floor;

    Parameters

    floor

    The floor to add.

  • Gets the elevator waypoints located in this building.

    Declaration

    Swift

    - (NSArray *)getElevatorsInBuilding;

    Return Value

    An array of elevator waypoints.

  • Gets the stair waypoint located in this building.

    Declaration

    Swift

    - (NSArray *)getStairsInBuilding;

    Return Value

    An array of stair waypoints.

  • Gets the exitPoints waypoint located in this building.

    Since

    1.1

    Declaration

    Swift

    - (NSArray *)getExitsInBuilding;

    Return Value

    An array of exit waypoints.

Public Properties
  • uid

    Unique identifier of the building.

    Declaration

    Swift

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

  • Identifies the building ordinal value

    Since

    1.2

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) NSInteger buildingNumber;

  • Display name of the building.

    Declaration

    Swift

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

  • The coordinates that make up the perimeter

    Since

    1.1

    Declaration

    Swift

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

  • Declaration

    Swift

    @interface VMMSBaseBuilding : NSObject

  • Declaration

    Swift

    @interface VMMSBaseBuilding : NSObject

  • Floors contained in this building

    Declaration

    Swift

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

  • 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

    Swift

    @property (readonly, nonatomic) CLLocationCoordinate2D centerLocation;