NCZone Class Reference

Class is used for storing location polygonal zones. More...

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

Inherits NSObject.

Properties
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.
NSString *	name
	zone's name.
NSString *	color
	zone's color.
NSString *	alias
	zone's alias.
BOOL	valid

Detailed Description

Class is used for storing location polygonal zones.

Referenced from Sublocation.

Definition at line 19 of file NCZone.h.

Property Documentation

alias

- (NSString*) alias

readnonatomicassign

zone's alias.

Swift code snippet:

        // Get zone alias
        let alias = zone.getAlias()
        print("Zone alias: \‍(alias ?? "nil")")

Objective C code snippet:

    // Get zone alias
    NSString *alias = [zone getAlias];
    NSLog(@"Zone alias: %@", alias);

Definition at line 124 of file NCZone.h.

color

- (NSString*) color

readnonatomicassign

zone's color.

Swift code snippet:

        // Get zone color
        let color = zone.getColor()
        print("Zone color: \‍(color ?? "nil")")

Objective C code snippet:

    // Get zone color
    NSString *color = [zone getColor];
    NSLog(@"Zone color: %@", color);

Definition at line 109 of file NCZone.h.

id

- (int32_t) id

readnonatomicassign

zone's identifier.

Swift code snippet:

        // Get zone ID
        let zoneId = zone.getId()
        print("Zone ID: \‍(zoneId)")

Objective C code snippet:

    // Get zone ID
    int32_t zoneId = [zone getId];
    NSLog(@"Zone ID: %d", zoneId);

Definition at line 79 of file NCZone.h.

locationId

- (int32_t) locationId

readnonatomicassign

zone's location identifier.

Swift code snippet:

        // Get zone location ID
        let locationId = zone.getLocationId()
        print("Zone location ID: \‍(locationId)")

Objective C code snippet:

    // Get zone location ID
    int32_t locationId = [zone getLocationId];
    NSLog(@"Zone location ID: %d", locationId);

Definition at line 49 of file NCZone.h.

name

- (NSString*) name

readnonatomicassign

zone's name.

Swift code snippet:

        // Get zone name
        let zoneName = zone.getName()
        print("Zone name: \‍(zoneName ?? "nil")")

Objective C code snippet:

    // Get zone name
    NSString *zoneName = [zone getName];
    NSLog(@"Zone name: %@", zoneName);

Definition at line 94 of file NCZone.h.

polygon

- (NCPolygon*) polygon

readnonatomicassign

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:

    // Get zone polygon
    NSArray<NCPoint *> *polygon = [zone getPolygon];
    NSLog(@"Zone polygon points: %lu", (unsigned long)polygon.count);

Definition at line 34 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:

    // Get zone sublocation ID
    int32_t sublocationId = [zone getSublocationId];
    NSLog(@"Zone sublocation ID: %d", sublocationId);

Definition at line 64 of file NCZone.h.

valid

- (BOOL) valid

readnonatomicassign

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 132 of file NCZone.h.

---

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

• NCZone.h