NCRouteEvent Class Reference

Class storing one route event payload. More...

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

Inherits NSObject.

Instance Methods
(nonnull instancetype)	- initWithType:turnEvent:transitionEntryEvent:transitionExitEvent:targetReachedEvent:
	Default constructor for class NCRouteEvent.

Class Methods
(nonnull instancetype)	+ routeEventWithType:turnEvent:transitionEntryEvent:transitionExitEvent:targetReachedEvent:
	Factory method for class NCRouteEvent.

Properties
NCRouteEventType	type
	Active event variant discriminator.
NCTurnEvent *	turnEvent
	Payload for turn events, set when type is TURN_EVENT.
NCTransitionEntryEvent *	transitionEntryEvent
	Payload for transition entry events.
NCTransitionExitEvent *	transitionExitEvent
	Payload for transition exit events.
NCTargetReachedEvent *	targetReachedEvent
	Payload for target reached events.

Detailed Description

Class storing one route event payload.

Referenced from RoutePath, RouteNode.

Definition at line 23 of file NCRouteEvent.h.

Method Documentation

initWithType:turnEvent:transitionEntryEvent:transitionExitEvent:targetReachedEvent:

- (nonnull instancetype) initWithType:		(NCRouteEventType)	type
turnEvent:		(nullable NCTurnEvent *)	turnEvent
transitionEntryEvent:		(nullable NCTransitionEntryEvent *)	transitionEntryEvent
transitionExitEvent:		(nullable NCTransitionExitEvent *)	transitionExitEvent
targetReachedEvent:		(nullable NCTargetReachedEvent *)	targetReachedEvent

Default constructor for class NCRouteEvent.

routeEventWithType:turnEvent:transitionEntryEvent:transitionExitEvent:targetReachedEvent:

+ (nonnull instancetype) routeEventWithType:		(NCRouteEventType)	type
turnEvent:		(nullable NCTurnEvent *)	turnEvent
transitionEntryEvent:		(nullable NCTransitionEntryEvent *)	transitionEntryEvent
transitionExitEvent:		(nullable NCTransitionExitEvent *)	transitionExitEvent
targetReachedEvent:		(nullable NCTargetReachedEvent *)	targetReachedEvent

Factory method for class NCRouteEvent.

Property Documentation

targetReachedEvent

- (NCTargetReachedEvent*) targetReachedEvent

readnonatomicassign

Payload for target reached events.

Swift code snippet:

        if let targetEvent = event.getTargetReachedEvent() {
            demonstrateTargetReachedEventUsage(targetEvent)
        }

Objective C code snippet:

    NCTargetReachedEvent *targetEvent = [event getTargetReachedEvent];
    if (targetEvent != nil) {
        [self demonstrateTargetReachedEventUsage:targetEvent];
    }

Definition at line 116 of file NCRouteEvent.h.

transitionEntryEvent

- (NCTransitionEntryEvent*) transitionEntryEvent

readnonatomicassign

Payload for transition entry events.

Swift code snippet:

        if let entryEvent = event.getTransitionEntryEvent() {
            demonstrateTransitionEntryEventUsage(entryEvent)
        }

Objective C code snippet:

    NCTransitionEntryEvent *entryEvent = [event getTransitionEntryEvent];
    if (entryEvent != nil) {
        [self demonstrateTransitionEntryEventUsage:entryEvent];
    }

Definition at line 86 of file NCRouteEvent.h.

transitionExitEvent

- (NCTransitionExitEvent*) transitionExitEvent

readnonatomicassign

Payload for transition exit events.

Swift code snippet:

        if let exitEvent = event.getTransitionExitEvent() {
            demonstrateTransitionExitEventUsage(exitEvent)
        }

Objective C code snippet:

    NCTransitionExitEvent *exitEvent = [event getTransitionExitEvent];
    if (exitEvent != nil) {
        [self demonstrateTransitionExitEventUsage:exitEvent];
    }

Definition at line 101 of file NCRouteEvent.h.

turnEvent

- (NCTurnEvent*) turnEvent

readnonatomicassign

Payload for turn events, set when type is TURN_EVENT.

Swift code snippet:

        if let turnEvent = event.getTurnEvent() {
            demonstrateTurnEventUsage(turnEvent)
        }

Objective C code snippet:

    NCTurnEvent *turnEvent = [event getTurnEvent];
    if (turnEvent != nil) {
        [self demonstrateTurnEventUsage:turnEvent];
    }

Definition at line 71 of file NCRouteEvent.h.

type

- (NCRouteEventType) type

readnonatomicassign

Active event variant discriminator.

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 56 of file NCRouteEvent.h.

---

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

• NCRouteEvent.h