VMMSWaypoint

@interface VMMSWaypoint : NSObject

Model that represents a waypoint. It includes its coordinate, building location, floor location, and more.

Since

1.0

Initializers

  • Designated Initializer.

    Declaration

    Swift

    - (instancetype)initWithId:(NSString *)uid
                  position:(CLLocationCoordinate2D)location;

    Parameters

    uid

    The unique identifer of the waypoint. The uid is expected to have a format of waypointname_type_b9_f9_9.
    location

    The coordinate of the waypoint.

    Return Value

    A VMMSWaypoint instance.

Public Methods

  • Get root waypoint this one is named after

    Since

    1.2

    Declaration

    Swift

    - (VMMSWaypoint *)getFirstNamesake;

Public Properties
  • uid

    The unique identifier of the waypoint.

    Declaration

    Swift

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

  • The building the waypoint is in.

    Since

    1.0

    Warning

    DEPRECATED since 1.1

    Declaration

    Swift

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

  • The name of the waypoint.

    Declaration

    Swift

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

  • The display name of the waypoint (i.e. Men’s Bathroom).

    Declaration

    Swift

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

  • The key for the VMMSMapFloor that the waypoint is on.

    Since

    1.0

    Warning

    DEPRECATED since 1.1

    Declaration

    Swift

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

  • The floor number that the waypoint is on.

    Since

    1.0

    Warning

    DEPRECATED since 1.1

    Declaration

    Swift

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

  • Reference to the map floor that this waypoint belongs to

    Since

    1.1

    Declaration

    Swift

    @property (readwrite, nonatomic) VMMSBaseFloor *mapFloor;

  • The type of waypoint (i.e. Amenity, Room, etc.)

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) VMMSWaypointType type;

  • The position of the waypoint (e.g. whether or not it’s indoors or outdoors).

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) VMMSWaypointPosition waypointPosition;

  • The coordinate of the waypoint.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D location;

  • The sequence number of a waypoint. This is used for elevators and stairs. Elevator waypoints, which are located on different floors, will have the same sequence number so they can be connected accordingly.

    Declaration

    Swift

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

  • Whether or not to describe a waypoint. Some waypoints don’t add value when describing the path, such as those that are in the middle of a straight line.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) BOOL doNotDescribe;

  • Whether or not this waypoint can be autolabeled.

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) BOOL canBeAutolabeled;

  • Used to indicate that this waypoint was processed during the auto-labeling process

    Declaration

    Swift

    @property (assign, readwrite, nonatomic) BOOL triaged;

  • Whether or not this waypoint is a destination.

    Declaration

    Swift

    @property (readonly, nonatomic) BOOL isDestinationType;

  • Whether or not the waypoint is traversible (i.e. A banquet room that can be used to get from point A to point B. However, we would rather use the hallway outside instead of going through this room. Therefore, this room would not be traversible.

    Declaration

    Swift

    @property (readonly, nonatomic) BOOL isTraversable;

  • Waypoint this one is named after

    Since

    1.2

    Declaration

    Swift

    @property (readwrite, nonatomic) VMMSWaypoint *namesake;