NCLocation Class Reference

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc. More...

#include <com/navigine/idl/objc/NCLocation.h>

Inherits NSObject.

Instance Methods
(nullable NCElevationGraph *)	- getElevationGraph:
	Method returns location elevation graph ElevationGraph for specified tag.
(nonnull NSArray< NSString * > *)	- getGraphTags
	Method returns list of available graph tags.
(nullable NCSublocation *)	- getSublocationById:
	Method is used for obtaining a sublocation with the specified identifier from the current location.
(nullable NCCategory *)	- getCategoryById:
	Method is used for obtaining a category with the specified identifier from the current location.

Properties
int32_t	id
	location's identifier.
int32_t	version
	location's version.
NSString *	name
	location name.
NSString *	descript
	location's description.
NSArray< NCCategory * > *	categories
	List of venue categories defined for the location Category.
NSArray< NCSublocation * > *	sublocations
	List of sublocations Sublocation.
BOOL	modified
	Flag indicates if location has been modified by user or not.

Detailed Description

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc.

Location instance can be obtained from LocationManager using LocationListener callback, when the location is loaded.

Referenced from LocationManager LocationListener.

Definition at line 23 of file NCLocation.h.

Method Documentation

getCategoryById:

- (nullable NCCategory *) getCategoryById:

(int32_t)

id

Method is used for obtaining a category with the specified identifier from the current location.

Parameters

id	category identifier.

Returns

Category of the current location with the specified identifier, if it exists. If category with the specified identifier doesn't exist, function returns null.

getElevationGraph:

- (nullable NCElevationGraph *) getElevationGraph:

(nonnull NSString *)

tag

Method returns location elevation graph ElevationGraph for specified tag.

Parameters

tag	Graph tag in CMS

Returns

Elevation graph instance or null.

ElevationGraph of the current location with the specified tag, if it exists. If elevation graph with the specified tag doesn't exist, function returns null.

getGraphTags

- (nonnull NSArray< NSString * > *) getGraphTags

Method returns list of available graph tags.

Returns

Array of existing tags

getSublocationById:

- (nullable NCSublocation *) getSublocationById:

(int32_t)

id

Method is used for obtaining a sublocation with the specified identifier from the current location.

Parameters

id	sublocation identifier.

Returns

The Sublocation of the current location with the specified identifier, if it exists. If sublocation with the specified identifier doesn't exist, function returns null.

Property Documentation

categories

- (NSArray<NCCategory *>*) categories

readnonatomicassign

List of venue categories defined for the location Category.

Definition at line 77 of file NCLocation.h.

descript

- (NSString*) descript

readnonatomicassign

location's description.

Definition at line 72 of file NCLocation.h.

id

- (int32_t) id

readnonatomicassign

location's identifier.

Definition at line 57 of file NCLocation.h.

modified

- (BOOL) modified

readnonatomicassign

Flag indicates if location has been modified by user or not.

Definition at line 87 of file NCLocation.h.

name

- (NSString*) name

readnonatomicassign

location name.

Definition at line 67 of file NCLocation.h.

sublocations

- (NSArray<NCSublocation *>*) sublocations

readnonatomicassign

List of sublocations Sublocation.

Definition at line 82 of file NCLocation.h.

version

- (int32_t) version

readnonatomicassign

location's version.

Definition at line 62 of file NCLocation.h.

---

The documentation for this class was generated from the following file:

• NCLocation.h