Class is used for storing location polygonal zones.
More...
#include <com/navigine/idl/objc/NCZone.h>
Inherits NSObject.
|
| NCPolygon * | polygon |
| | zone's list of points composing the polygonal zone Polygon
|
| |
| int32_t | locationId |
| | zone's location identifier.
|
| |
| int32_t | sublocationId |
| | zone's sublocationId identifier.
|
| |
| int32_t | id |
| | zone's identifier.
|
| |
| NSNumber * | guid |
| | Optional stable zone GUID used by live tracking (MQTT zone_guids). Distinct from id; may be missing in older location archives.
|
| |
| NSString * | name |
| | zone's name.
|
| |
| UIColor * | color |
| | zone's color.
|
| |
| NSString * | alias |
| | zone's alias.
|
| |
| BOOL | valid |
| |
Class is used for storing location polygonal zones.
Referenced from Sublocation.
Definition at line 20 of file NCZone.h.
◆ alias
zone's alias.
Swift code snippet:
// Get zone alias
let alias = zone.getAlias()
print("Zone alias: \(alias ?? "nil")")
Objective C code snippet:
NSString *alias = [zone getAlias];
NSLog(@"Zone alias: %@", alias);
Definition at line 141 of file NCZone.h.
◆ color
zone's color.
Swift code snippet:
// Get zone color
let color = zone.getColor()
print("Zone color: \(color)")
Objective C code snippet:
UIColor *color = [zone getColor];
NSLog(@"Zone color: %@", color);
Definition at line 126 of file NCZone.h.
◆ guid
Optional stable zone GUID used by live tracking (MQTT zone_guids). Distinct from id; may be missing in older location archives.
Swift code snippet:
if let guid = zone.getGuid() {
print("Zone GUID: \(guid)")
}
Objective C code snippet:
NSNumber *zoneGuid = [zone getGuid];
if (zoneGuid != nil) {
NSLog(@"Zone GUID: %@", zoneGuid);
}
Definition at line 96 of file NCZone.h.
◆ id
zone's identifier.
Swift code snippet:
// Get zone ID
let zoneId = zone.getId()
print("Zone ID: \(zoneId)")
Objective C code snippet:
int32_t zoneId = [zone getId];
NSLog(@"Zone ID: %d", zoneId);
Definition at line 80 of file NCZone.h.
◆ locationId
zone's location identifier.
Swift code snippet:
// Get zone location ID
let locationId = zone.getLocationId()
print("Zone location ID: \(locationId)")
Objective C code snippet:
int32_t locationId = [zone getLocationId];
NSLog(@"Zone location ID: %d", locationId);
Definition at line 50 of file NCZone.h.
◆ name
zone's name.
Swift code snippet:
// Get zone name
let zoneName = zone.getName()
print("Zone name: \(zoneName ?? "nil")")
Objective C code snippet:
NSString *zoneName = [zone getName];
NSLog(@"Zone name: %@", zoneName);
Definition at line 111 of file NCZone.h.
◆ polygon
zone's list of points composing the polygonal zone Polygon
Swift code snippet:
// Get zone polygon
let polygon = zone.getPolygon()
print("Zone polygon points: \(polygon.count)")
Objective C code snippet:
NSArray<NCPoint *> *polygon = [zone getPolygon];
NSLog(@"Zone polygon points: %lu", (unsigned long)polygon.count);
Definition at line 35 of file NCZone.h.
◆ sublocationId
| - (int32_t) sublocationId |
|
readnonatomicassign |
zone's sublocationId identifier.
Swift code snippet:
// Get zone sublocation ID
let sublocationId = zone.getSublocationId()
print("Zone sublocation ID: \(sublocationId)")
Objective C code snippet:
int32_t sublocationId = [zone getSublocationId];
NSLog(@"Zone sublocation ID: %d", sublocationId);
Definition at line 65 of file NCZone.h.
◆ valid
Tells if this object is valid or not. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now.
Definition at line 149 of file NCZone.h.
The documentation for this class was generated from the following file:
