NCRouteEvent Class Reference

Class is used for storing the route path events. More...

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

Inherits NSObject.

Instance Methods
(nonnull instancetype)	- initWithType:value:distance:
	Default constructor for class NCRouteEvent.

Class Methods
(nonnull instancetype)	+ routeEventWithType:value:distance:
	Factory method for class NCRouteEvent.

Properties
NCRouteEventType	type
	Incoming event type RouteEventType.
int32_t	value
	Indicates angle in degrees for TURN_LEFT/TURN_RIGHT types RouteEventType and target sublocation unique identifier if type is TRANSITION Sublocation.
float	distance
	distance from the beginning of the route to incoming event in meters.

Detailed Description

Class is used for storing the route path events.

Referenced from: RoutePath.

Definition at line 19 of file NCRouteEvent.h.

Method Documentation

initWithType:value:distance:

- (nonnull instancetype) initWithType:		(NCRouteEventType)	type
value:		(int32_t)	value
distance:		(float)	distance

Default constructor for class NCRouteEvent.

routeEventWithType:value:distance:

+ (nonnull instancetype) routeEventWithType:		(NCRouteEventType)	type
value:		(int32_t)	value
distance:		(float)	distance

Factory method for class NCRouteEvent.

Property Documentation

distance

- (float) distance

readnonatomicassign

distance from the beginning of the route to incoming event in meters.

Swift code snippet:

        // Get distance from route start
        let distance = event.getDistance()
        print("Event distance: \‍(distance) meters")

Objective C code snippet:

    // Get distance from route start
    double distance = [event getDistance];
    NSLog(@"Event distance: %f meters", distance);

Definition at line 76 of file NCRouteEvent.h.

type

- (NCRouteEventType) type

readnonatomicassign

Incoming event type RouteEventType.

Swift code snippet:

        // Get event type
        let type = event.getType()
        print("Event type: \‍(type)")

Objective C code snippet:

    // Get event type
    NCRouteEventType type = [event getType];
    NSLog(@"Event type: %ld", (long)type);

Definition at line 47 of file NCRouteEvent.h.

value

- (int32_t) value

readnonatomicassign

Indicates angle in degrees for TURN_LEFT/TURN_RIGHT types RouteEventType and target sublocation unique identifier if type is TRANSITION Sublocation.

Swift code snippet:

        // Get event value (angle for turns, sublocation ID for transitions)
        let value = event.getValue()
        print("Event value: \‍(value)")

Objective C code snippet:

    // Get event value (angle for turns, sublocation ID for transitions)
    int32_t value = [event getValue];
    NSLog(@"Event value: %d", value);

Definition at line 62 of file NCRouteEvent.h.

---

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

• NCRouteEvent.h