LandmarkObject

Objective-C


@interface LandmarkObject : NSObject <NSSecureCoding>

Swift

class LandmarkObject : NSObject, NSSecureCoding

This class encapsulates landmark information.

  • Returns a landmark object with the given name and location.

    Declaration

    Objective-C

    + (nonnull instancetype)landmarkWithName:(nonnull NSString *)name
                                location:(nonnull CoordinatesObject *)location;

    Swift

    class func landmark(withName name: String, location: CoordinatesObject) -> Self

  • Initializes and returns a newly allocated object using the model data.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Returns the model data.

    Declaration

    Objective-C

    - (nonnull void *)getModelData;

  • Returns the identifier of the landmark. Returning -1 if it does not have an associated ID, i.e. the landmark doesn’t belong to a landmark store.

    Declaration

    Objective-C

    - (int)getLandmarkIdentifier;

    Swift

    func getLandmarkIdentifier() -> Int32

  • Returns the store identifier of the landmark.

    Declaration

    Objective-C

    - (int)getLandmarkStoreIdentifier;

    Swift

    func getLandmarkStoreIdentifier() -> Int32

  • Returns the name of the landmark.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkName;

    Swift

    func getLandmarkName() -> String

  • Set the landmark name.

    Declaration

    Objective-C

    - (void)setLandmarkName:(nonnull NSString *)name;

    Swift

    func setLandmarkName(_ name: String)

  • Returns the description of the landmark.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkDescription;

    Swift

    func getLandmarkDescription() -> String

  • Set the description of this landmark.

    Declaration

    Objective-C

    - (void)setLandmarkDescription:(nonnull NSString *)description;

    Swift

    func setLandmarkDescription(_ description: String)

  • Returns the author of this landmark.

    Declaration

    Objective-C

    - (nonnull NSString *)getAuthor;

    Swift

    func getAuthor() -> String

  • Set the author of this landmark.

    Declaration

    Objective-C

    - (void)setAuthor:(nonnull NSString *)value;

    Swift

    func setAuthor(_ value: String)

  • Returns the provider id of this landmark. .

    Declaration

    Objective-C

    - (int)getProviderId;

    Swift

    func getProviderId() -> Int32

  • Set provider id of this landmark.

    Declaration

    Objective-C

    - (void)setProviderId:(int)value;

    Swift

    func setProviderId(_ value: Int32)

  • Returns the landmark timestamp.

    Declaration

    Objective-C

    - (nullable TimeObject *)getTimeStamp;

    Swift

    func getTimeStamp() -> TimeObject?

  • Set the timestamp.

    Declaration

    Objective-C

    - (void)setTimeStamp:(nullable TimeObject *)object;

    Swift

    func setTimeStamp(_ object: TimeObject?)

  • Returns the coordinates of the landmark.

    Declaration

    Objective-C

    - (nonnull CoordinatesObject *)getCoordinates;

    Swift

    func getCoordinates() -> CoordinatesObject

  • Set the centroid coordinates.

    Declaration

    Objective-C

    - (void)setCoordinates:(nonnull CoordinatesObject *)location;

    Swift

    func setCoordinates(_ location: CoordinatesObject)

  • Returns the image object.

    Declaration

    Objective-C

    - (nullable ImageObject *)getImage;

    Swift

    func getImage() -> ImageObject?

  • Set the image object.

    Declaration

    Objective-C

    - (void)setImage:(nonnull ImageObject *)object;

    Swift

    func setImage(_ object: ImageObject)

  • Set the landmark image buffer data.

    Declaration

    Objective-C

    - (void)setImageData:(nonnull NSData *)data format:(ImageFormat)format;

    Swift

    func setImageData(_ data: Data, format: ImageFormat)

  • Returns the extra image object.

    Declaration

    Objective-C

    - (nullable ImageObject *)getExtraImage;

    Swift

    func getExtraImage() -> ImageObject?

  • Set the extra image object.

    Declaration

    Objective-C

    - (void)setExtraImage:(nonnull ImageObject *)object;

    Swift

    func setExtraImage(_ object: ImageObject)

  • Returns the image of the landmark. @details The image is cached after first render.

    Declaration

    Objective-C

    - (nullable UIImage *)getLandmarkImage:(CGSize)size;

    Swift

    func getLandmarkImage(_ size: CGSize) -> UIImage?

  • Returns the image of the landmark.

    Declaration

    Objective-C

    - (nullable UIImage *)getLandmarkImage:(CGSize)size
                                 scale:(CGFloat)scale
                                   ppi:(NSInteger)ppi;

    Swift

    func getLandmarkImage(_ size: CGSize, scale: CGFloat, ppi: Int) -> UIImage?

    Parameters

    size

    The size in pixels.
    scale

    The screen scale factor.
    ppi

    The screen pixel per inch. @details The image is cached after first render.

  • Set the landmark image. The supported formats are: PNG.

    Declaration

    Objective-C

    - (void)setLandmarkImage:(nonnull UIImage *)image;

    Swift

    func setLandmarkImage(_ image: UIImage)

  • Returns the extra info attached to this landmark.

    Declaration

    Objective-C

    - (nonnull NSArray<NSString *> *)getExtraInfo;

    Swift

    func getExtraInfo() -> [String]

  • Set the extra info attached to this landmark.

    Declaration

    Objective-C

    - (void)setExtraInfo:(nonnull NSArray<NSString *> *)array;

    Swift

    func setExtraInfo(_ array: [String])

  • Find extra info.

    Declaration

    Objective-C

    - (nonnull NSString *)findExtraInfo:(nonnull NSString *)string;

    Swift

    func findExtraInfo(_ string: String) -> String

  • Returns the landmark categories list.

    Declaration

    Objective-C

    - (nonnull NSArray<LandmarkCategoryObject *> *)getCategories;

    Swift

    func getCategories() -> [LandmarkCategoryObject]

  • Returns the contour rectangle geographic area.

    Declaration

    Objective-C

    - (nullable RectangleGeographicAreaObject *)getContourGeograficArea;

    Swift

    func getContourGeograficArea() -> RectangleGeographicAreaObject?

  • Returns true if the contour rectangle geographic area is empty.

    Declaration

    Objective-C

    - (BOOL)isContourGeograficAreaEmpty;

    Swift

    func isContourGeograficAreaEmpty() -> Bool

  • Returns the direct access to the contact info attached to this landmark.

    Declaration

    Objective-C

    - (nullable ContactInfoObject *)getContactInfo;

    Swift

    func getContactInfo() -> ContactInfoObject?

  • Set the contact info. Phone numbers & descriptions, email addresses & descriptions, URLs & descriptions.

    Declaration

    Objective-C

    - (void)setContactInfo:(nullable ContactInfoObject *)object;

    Swift

    func setContactInfo(_ object: ContactInfoObject?)

  • Returns the address search field name.

    Declaration

    Objective-C

    - (nonnull NSString *)getAddressFieldNameWithType:(AddressSearchFieldType)type;

    Swift

    func getAddressFieldName(with type: AddressSearchFieldType) -> String

    Parameters

    type

    The address search field type.

  • Returns the landmark distance formatted string.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkDistanceFormattedWithLocation:
    (nonnull CoordinatesObject *)location;

    Swift

    func getLandmarkDistanceFormatted(withLocation location: CoordinatesObject) -> String

    Parameters

    location

    The reference point.

  • Returns the landmark distance unit formatted string.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkDistanceUnitFormattedWithLocation:
    (nonnull CoordinatesObject *)location;

    Swift

    func getLandmarkDistanceUnitFormatted(withLocation location: CoordinatesObject) -> String

    Parameters

    location

    The reference point.

  • Reset cache image.

    Declaration

    Objective-C

    - (void)resetCacheImage;

    Swift

    func resetCacheImage()

  • Returns the landmark name formatted string.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkNameFormatted;

    Swift

    func getLandmarkNameFormatted() -> String

  • Returns the landmark description formatted string.

    Declaration

    Objective-C

    - (nonnull NSString *)getLandmarkDescriptionFormatted;

    Swift

    func getLandmarkDescriptionFormatted() -> String