MBNNGraphAccessor.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <CoreLocation/CoreLocation.h>
  4. @class MBNNCacheHandle;
  5. @class MBNNEdgeAdasAttributes;
  6. @class MBNNEdgeMetadata;
  7. @class MBNNGraphPath;
  8. @class MBNNGraphPosition;
  9. NS_SWIFT_NAME(GraphAccessor)
  10. __attribute__((visibility ("default")))
  11. @interface MBNNGraphAccessor : NSObject
  12. // This class provides custom init which should be called
  13. - (nonnull instancetype)init NS_UNAVAILABLE;
  14. // This class provides custom init which should be called
  15. + (nonnull instancetype)new NS_UNAVAILABLE;
  16. /**
  17. * Creates GraphAccessor that accesses map data using provided cache.
  18. * Use `mapbox::navigator::CacheFactory` to build cache handle.
  19. */
  20. - (nonnull instancetype)initWithCache:(nonnull MBNNCacheHandle *)cache;
  21. /**
  22. * Returns Graph Edge meta-information for the given GraphId of the edge.
  23. * If edge with given edgeId is not accessible, returns null
  24. */
  25. - (nullable MBNNEdgeMetadata *)getEdgeMetadataForEdgeId:(uint64_t)edgeId __attribute((ns_returns_retained));
  26. /**
  27. * Returns Graph Edge geometry for the given GraphId of the edge.
  28. * If edge with given edgeId is not accessible, returns null
  29. */
  30. - (nullable NSArray<CLLocation *> *)getEdgeShapeForEdgeId:(uint64_t)edgeId __attribute((ns_returns_retained));
  31. /**
  32. * Returns geometry of given path on graph.
  33. * If any of path edges is not accessible, returns null.
  34. */
  35. - (nullable NSArray<CLLocation *> *)getPathShapeForPath:(nonnull MBNNGraphPath *)path __attribute((ns_returns_retained));
  36. /**
  37. * Returns geographical coordinate of given position on graph
  38. * If position's edge is not accessible, returns null.
  39. */
  40. - (nullable CLLocation *)getPositionCoordinateForPosition:(nonnull MBNNGraphPosition *)position __attribute((ns_returns_retained));
  41. /**
  42. * Caution: Beta feature that cat be changed soon.
  43. *
  44. * Returns ADAS data for a given Edge.
  45. * If no ADAS data is available, returns null
  46. */
  47. - (nullable MBNNEdgeAdasAttributes *)getAdasAttributesForEdgeId:(uint64_t)edgeId __attribute((ns_returns_retained));
  48. @end