GeographicAreaObject

Objective-C


@interface GeographicAreaObject : NSObject

Swift

class GeographicAreaObject : NSObject

This class encapsulates geographic area information.

  • 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 type of the geographic area.

    Declaration

    Objective-C

    - (GeographicAreaType)getType;

    Swift

    func getType() -> GeographicAreaType
  • Returns true if the provided point is contained by the geographic area.

    Declaration

    Objective-C

    - (BOOL)containsCoordinates:(nonnull CoordinatesObject *)location;

    Swift

    func containsCoordinates(_ location: CoordinatesObject) -> Bool
  • Returns the center of the geographic area.

    Declaration

    Objective-C

    - (nonnull CoordinatesObject *)getCenterPoint;

    Swift

    func getCenterPoint() -> CoordinatesObject
  • Check if two geographic areas are equal.

    Declaration

    Objective-C

    - (BOOL)equals:(nonnull GeographicAreaObject *)geoArea;

    Swift

    func equals(_ geoArea: GeographicAreaObject) -> Bool
  • Check if this is a default object ( nothing was modified on it since creation ).

    Declaration

    Objective-C

    - (BOOL)isDefault;

    Swift

    func isDefault() -> Bool
  • Check empty area.

    Declaration

    Objective-C

    - (BOOL)isEmpty;

    Swift

    func isEmpty() -> Bool
  • Reset the object to default.

    Declaration

    Objective-C

    - (void)reset;

    Swift

    func reset()