ObjectiveC Secondary classes

List of secondary classes for Navigine iOS SDK. More...

Classes
class	NCBitmapRegionDecoder
	Class is used for getting bitmaps (png, jpg, svg) from byte array. More...
class	NCLocationInfo
	General information about location. More...
class	NCLogInfo
	Represents metadata for a log file. More...
class	NCNotification
	Class is used for working with the notifications and storing its data. More...
class	NCPosition
	Class describing user's position. More...
class	NCRouteEvent
	Class storing one route event payload. More...
class	NCRouteNode
	Class describing one node of the evaluated route. More...
class	NCRouteOptions
	Class is used for describing routing options of AsyncRouteManager. More...
class	NCSensorMeasurement
	Structure representing a sensor measurement with type, values, and timestamp. More...
class	NCSignalMeasurement
	Structure representing a signal measurement with type, identifier, RSSI, distance, and timestamp. More...
class	NCTargetReachedEvent
	Event indicating the route target has been reached. More...
class	NCTransitionEntryEvent
	Event describing entering another level/sublocation transition. More...
class	NCTransitionExitEvent
	Event describing exiting a level/sublocation transition. More...
class	NCTurnEvent
	Class describing turn guidance event. More...
class	NCVector3d
	Structure representing a 3D vector for sensor measurements. More...
class	NCZoneEvent
	Class described user zone event. More...

Enumerations
enum	NCRouteEventType {   NCRouteEventTypeTURNEVENT ,   NCRouteEventTypeTRANSITIONENTRYEVENT ,   NCRouteEventTypeTRANSITIONEXITEVENT ,   NCRouteEventTypeTARGETREACHEDEVENT }
	Enum describing route event variants. More...
enum	NCRouteStatus {   NCRouteStatusMissingGraph ,   NCRouteStatusMissingPosition ,   NCRouteStatusMissingRoute ,   NCRouteStatusMissingProjection ,   NCRouteStatusNewRoute }
	Enum describing possible router states. More...
enum	NCSensorType {   NCSensorTypeACCELEROMETER ,   NCSensorTypeMAGNETOMETER ,   NCSensorTypeGYROSCOPE ,   NCSensorTypeBAROMETER ,   NCSensorTypeLOCATION ,   NCSensorTypeORIENTATION ,   NCSensorTypeNMEA ,   NCSensorTypeODOMETER ,   NCSensorTypeGNSS }
	Enum defining types of sensors used in measurements. More...
enum	NCSignalType {   NCSignalTypeWIFI ,   NCSignalTypeBEACON ,   NCSignalTypeBLUETOOTH ,   NCSignalTypeEDDYSTONE ,   NCSignalTypeWIFIRTT }
	Enum defining types of signals used in measurements. More...
enum	NCTransmitterStatus {   NCTransmitterStatusNone ,   NCTransmitterStatusNew ,   NCTransmitterStatusDeleted ,   NCTransmitterStatusModified }
	enum described possible transmitter state. More...
enum	NCTurnType {   NCTurnTypeLEFTSLIGHT ,   NCTurnTypeLEFTNORMAL ,   NCTurnTypeLEFTSHARP ,   NCTurnTypeRIGHTSLIGHT ,   NCTurnTypeRIGHTNORMAL ,   NCTurnTypeRIGHTSHARP ,   NCTurnTypeCOMPLETE }
	Enum describing turn direction/severity for TurnEvent. More...
enum	NCZoneEventType {   NCZoneEventTypeEnter ,   NCZoneEventTypeExit }
	enum described zone event types More...

Detailed Description

List of secondary classes for Navigine iOS SDK.

Enumeration Type Documentation

NCRouteEventType

enum NCRouteEventType

Enum describing route event variants.

Referenced from RouteEvent.

Swift code snippet:

        // Get all route event type values
        let types: [NCRouteEventType] = [.turnLeft, .turnRight, .transition]
        print("Available route event types:")
        for type in types {
            print("  - \‍(type)")
        }

Objective C code snippet:

    // Get all route event type values
    NSArray<NSNumber *> *types = @[
        @(NCRouteEventTypeTurnLeft),
        @(NCRouteEventTypeTurnRight),
        @(NCRouteEventTypeTransition)
    ];
    NSLog(@"Available route event types:");
    for (NSNumber *type in types) {
        NSLog(@"  - %ld", (long)[type integerValue]);
    }

Enumerator
NCRouteEventTypeTURNEVENT
NCRouteEventTypeTRANSITIONENTRYEVENT
NCRouteEventTypeTRANSITIONEXITEVENT
NCRouteEventTypeTARGETREACHEDEVENT

Definition at line 25 of file NCRouteEventType.h.

NCRouteStatus

enum NCRouteStatus

Enum describing possible router states.

Referenced from AsyncRouteListener.

Swift code snippet:

        // Demonstrate all RouteStatus values
        print("Available RouteStatus values:")
        let allStatuses: [NCRouteStatus] = [.missingGraph, .missingPosition, .missingRoute, .missingProjection, .newRoute]
        for status in allStatuses {
            print("  - \‍(status): \‍(status.rawValue)")
        }
 
        // Demonstrate status checking
        let testStatus: NCRouteStatus = .newRoute
        switch testStatus {
        case .newRoute:
            print("Router is ready for navigation")
        case .missingGraph:
            print("Router is missing the route graph")
        case .missingPosition:
            print("Router is missing the current position")
        case .missingProjection:
            print("Current position is off the route graph")
        case .missingRoute:
            print("Router unable to find the route to the destination point")
        }

Objective C code snippet:

    // Demonstrate all RouteStatus values
    NSLog(@"Available RouteStatus values:");
    NSArray *allStatuses = @[@(NCRouteStatusMissingGraph), @(NCRouteStatusMissingPosition), @(NCRouteStatusMissingRoute), @(NCRouteStatusMissingProjection), @(NCRouteStatusNewRoute)];
    for (NSNumber *statusNumber in allStatuses) {
        NCRouteStatus status = [statusNumber integerValue];
        NSLog(@"  - %@: %@", @(status), @(status));
    }
 
    // Demonstrate status checking
    NCRouteStatus testStatus = NCRouteStatusNewRoute;
    switch (testStatus) {
        case NCRouteStatusNewRoute:
            NSLog(@"Router is ready for navigation");
            break;
        case NCRouteStatusMissingGraph:
            NSLog(@"Router is missing the route graph");
            break;
        case NCRouteStatusMissingPosition:
            NSLog(@"Router is missing the current position");
            break;
        case NCRouteStatusMissingProjection:
            NSLog(@"Current position is off the route graph");
            break;
        case NCRouteStatusMissingRoute:
            NSLog(@"Router unable to find the route to the destination point");
            break;
    }

Enumerator
NCRouteStatusMissingGraph	Router is missing the route graph.
NCRouteStatusMissingPosition	Router is missing the current position.
NCRouteStatusMissingRoute	Router unable to find the route to the destination point.
NCRouteStatusMissingProjection	Current position is off the route graph.
NCRouteStatusNewRoute	Router is ready and has a valid route.

Definition at line 26 of file NCRouteStatus.h.

NCSensorType

enum NCSensorType

Enum defining types of sensors used in measurements.

Referenced from SensorMeasurement.

Enumerator
NCSensorTypeACCELEROMETER	Accelerometer sensor type. Accelerometer.
NCSensorTypeMAGNETOMETER	Magnetometer sensor type. Magnetometer.
NCSensorTypeGYROSCOPE	Gyroscope sensor type. Gyroscope.
NCSensorTypeBAROMETER	Barometer sensor type. Barometer.
NCSensorTypeLOCATION	Location sensor type. GNSS.
NCSensorTypeORIENTATION	Orientation sensor type.
NCSensorTypeNMEA	NMEA GNSS sentence metadata. SensorMeasurement values: x = sentence number, y = satellite count, z unused.
NCSensorTypeODOMETER	Odometer / wheel speed. Values: x = speed (m/s), y = accuracy if present else 0, z unused.
NCSensorTypeGNSS	Raw GNSS vectors (pseudo-ranges, etc.) — summarized for the API. Values: x = pseudoRanges count, y = pseudoRangeRates count, z = satellitesPositions count.

Definition at line 15 of file NCSensorType.h.

NCSignalType

enum NCSignalType

Enum defining types of signals used in measurements.

Referenced from SignalMeasurement.

Enumerator
NCSignalTypeWIFI	Wi-Fi signal type. Wi-Fi.
NCSignalTypeBEACON	Bluetooth Low Energy (BLE) beacon signal type. iBeacon.
NCSignalTypeBLUETOOTH	Bluetooth signal type. Bluetooth.
NCSignalTypeEDDYSTONE	Eddystone beacon signal type. Eddystone.
NCSignalTypeWIFIRTT	Wi-Fi Round-Trip Time signal type. Wi-Fi_RTT.

Definition at line 15 of file NCSignalType.h.

NCTransmitterStatus

enum NCTransmitterStatus

enum described possible transmitter state.

Referenced from Beacon, Eddystone, Wifi.

Swift code snippet:

        // Get all transmitter status values
        print("Available transmitter statuses:")
        print("  - NCTransmitterStatusActive: \‍(NCTransmitterStatusActive)")
        print("  - NCTransmitterStatusInactive: \‍(NCTransmitterStatusInactive)")

Objective C code snippet:

    // Get all transmitter status values
    NSLog(@"Available transmitter statuses:");
    NSLog(@"  - NCTransmitterStatusActive: %ld", (long)NCTransmitterStatusActive);
    NSLog(@"  - NCTransmitterStatusInactive: %ld", (long)NCTransmitterStatusInactive);

Enumerator
NCTransmitterStatusNone	Syncronized with CMS.
NCTransmitterStatusNew	Added in SDK but not syncronized with CMS.
NCTransmitterStatusDeleted	Deleted in SDK but not syncronized with CMS.
NCTransmitterStatusModified	Changed in SDK but not syncronized with CMS.

Definition at line 26 of file NCTransmitterStatus.h.

NCTurnType

enum NCTurnType

Enum describing turn direction/severity for TurnEvent.

Referenced from TurnEvent.

Swift code snippet:

        let types: [NCTurnType] = [.leftSlight, .leftNormal, .leftSharp, .rightSlight, .rightNormal, .rightSharp, .complete]
        print("Available turn types:")
        for type in types {
            print("  - \‍(type)")
        }

Objective C code snippet:

    NSArray<NSNumber *> *types = @[
        @(NCTurnTypeLeftSlight),
        @(NCTurnTypeLeftNormal),
        @(NCTurnTypeLeftSharp),
        @(NCTurnTypeRightSlight),
        @(NCTurnTypeRightNormal),
        @(NCTurnTypeRightSharp),
        @(NCTurnTypeComplete)
    ];
    NSLog(@"Available turn types:");
    for (NSNumber *type in types) {
        NSLog(@"  - %ld", (long)[type integerValue]);
    }

Enumerator
NCTurnTypeLEFTSLIGHT	Minor left adjustment (approx. 10°–40°).
NCTurnTypeLEFTNORMAL	Standard left turn (approx. 40°–100°).
NCTurnTypeLEFTSHARP	Sharp left turn (approx. 100°–160°).
NCTurnTypeRIGHTSLIGHT	Minor right adjustment (approx. 10°–40°).
NCTurnTypeRIGHTNORMAL	Standard right turn (approx. 40°–100°).
NCTurnTypeRIGHTSHARP	Sharp right turn (approx. 100°–160°).
NCTurnTypeCOMPLETE	Near U-turn / reversal (approx. 160°–180°).

Definition at line 25 of file NCTurnType.h.

NCZoneEventType

enum NCZoneEventType

enum described zone event types

Referenced from ZoneEvent.

Swift code snippet:

        // Get all zone event type values
        print("Available zone event types:")
        print("  - ZoneEventType.enter: \‍(ZoneEventType.enter)")
        print("  - ZoneEventType.exit: \‍(ZoneEventType.exit)")

Objective C code snippet:

    // Get all zone event type values
    NSLog(@"Available zone event types:");
    NSLog(@"  - NCZoneEventTypeEnter: %ld", (long)NCZoneEventTypeEnter);
    NSLog(@"  - NCZoneEventTypeExit: %ld", (long)NCZoneEventTypeExit);

Enumerator
NCZoneEventTypeEnter	Happens when user enters paticular zone;.
NCZoneEventTypeExit	Happens when user leaves paticular zone, sublocation has been changed or zone has been removed;.

Definition at line 26 of file NCZoneEventType.h.