Class NCLocation - Navigine/Indoor-Navigation-iOS-Mobile-SDK-2.0 GitHub Wiki
NCLocation class is used for storing location parameters: identifier, version, name, a list of sublocations, etc. NCLocation instance can be obtained from NCLocationManager using NCLocationListeners' callback, when the location is loaded.
Referenced from: NCLocationManager.
@interface NCLocation : NSObject
- (nullable NCElevationGraph *)getElevationGraph:(nonnull NSString *)tag;
- (nonnull NSArray<NSString *> *)getGraphTags;
- (nullable NCSublocation *)getSublocationById:(int32_t)id;
- (nullable NCCategory *)getCategoryById:(int32_t)id;
@property (nonatomic, readonly) int32_t id;
@property (nonatomic, readonly) int32_t version;
@property (nonatomic, nonnull, readonly) NSString * name;
@property (nonatomic, nonnull, readonly) NSString * descript;
@property (nonatomic, nonnull, readonly) NSArray<NCCategory *> * categories;
@property (nonatomic, nonnull, readonly) NSArray<NCSublocation *> * sublocations;
@end
-
id
- location's id in personal account -
version
- location's version -
name
- location's name in personal account -
descript
- location's description in personal account -
sublocations
- array with sublocations of your location -
categories
- array with categories of your location
- (nullable NCElevationGraph *)getElevationGraph:(nonnull NSString *)tag;
Function is used for getting elevation graph by tag.
-
tag
— the elevation graph tag.
The NCElevationGraph of the current location.
- (nonnull NSArray<NSString *> *)getGraphTags;
Function is used for getting graph tags, like default, alternative, etc.
Array of names of graph tags.
- (nullable NCSublocation *)getSublocationById:(int32_t)id;
Function is used for obtaining a sublocation with the specified identifier from the current location.
-
id
— the sublocation identifier.
The NCSublocation of the current location with the specified
identifier, if it exists. If sublocation with the specified identifier doesn't
exist, function returns null
.
- (nullable NCCategory *)getCategoryById:(int32_t)id;
Function is used for obtaining a category with the specified identifier from the current location.
-
id
— the category identifier.
The NCCategory of the current location with the specified
identifier, if it exists. If category with the specified identifier doesn't
exist, function returns null
.