com.navigine.idl.java.RouteEvent Class Reference

Class storing one route event payload. More...

Public Member Functions
	RouteEvent (RouteEventType type, TurnEvent turnEvent, TransitionEntryEvent transitionEntryEvent, TransitionExitEvent transitionExitEvent, TargetReachedEvent targetReachedEvent)
	Default constructor for class RouteEvent.
RouteEventType	getType ()
	Active event variant discriminator.
TurnEvent	getTurnEvent ()
	Payload for turn events, set when type is TURN_EVENT.
TransitionEntryEvent	getTransitionEntryEvent ()
	Payload for transition entry events.
TransitionExitEvent	getTransitionExitEvent ()
	Payload for transition exit events.
TargetReachedEvent	getTargetReachedEvent ()
	Payload for target reached events.
String	toString ()

Detailed Description

Class storing one route event payload.

Referenced from RoutePath, RouteNode.

Definition at line 16 of file RouteEvent.java.

Constructor & Destructor Documentation

RouteEvent()

com.navigine.idl.java.RouteEvent.RouteEvent ( RouteEventType type, TurnEvent turnEvent, TransitionEntryEvent transitionEntryEvent, TransitionExitEvent transitionExitEvent, TargetReachedEvent targetReachedEvent )

inline

Default constructor for class RouteEvent.

Definition at line 32 of file RouteEvent.java.

Member Function Documentation

getTargetReachedEvent()

TargetReachedEvent com.navigine.idl.java.RouteEvent.getTargetReachedEvent ( )

inline

Payload for target reached events.

Returns

Java code snippet:

        TargetReachedEvent reachedEvent = event.getTargetReachedEvent();
        if (reachedEvent != null) {
            demonstrateTargetReachedEventUsage(reachedEvent);
        }

Kotlin code snippet:

        val reachedEvent = event.targetReachedEvent
        reachedEvent?.let { demonstrateTargetReachedEventUsage(it) }

Definition at line 126 of file RouteEvent.java.

getTransitionEntryEvent()

TransitionEntryEvent com.navigine.idl.java.RouteEvent.getTransitionEntryEvent ( )

inline

Payload for transition entry events.

Returns

Java code snippet:

        TransitionEntryEvent entryEvent = event.getTransitionEntryEvent();
        if (entryEvent != null) {
            demonstrateTransitionEntryEventUsage(entryEvent);
        }

Kotlin code snippet:

        val entryEvent = event.transitionEntryEvent
        entryEvent?.let { demonstrateTransitionEntryEventUsage(it) }

Definition at line 92 of file RouteEvent.java.

getTransitionExitEvent()

TransitionExitEvent com.navigine.idl.java.RouteEvent.getTransitionExitEvent ( )

inline

Payload for transition exit events.

Returns

Java code snippet:

        TransitionExitEvent exitEvent = event.getTransitionExitEvent();
        if (exitEvent != null) {
            demonstrateTransitionExitEventUsage(exitEvent);
        }

Kotlin code snippet:

        val exitEvent = event.transitionExitEvent
        exitEvent?.let { demonstrateTransitionExitEventUsage(it) }

Definition at line 109 of file RouteEvent.java.

getTurnEvent()

TurnEvent com.navigine.idl.java.RouteEvent.getTurnEvent ( )

inline

Payload for turn events, set when type is TURN_EVENT.

Returns

Java code snippet:

        TurnEvent turnEvent = event.getTurnEvent();
        if (turnEvent != null) {
            demonstrateTurnEventUsage(turnEvent);
        }

Kotlin code snippet:

        val turnEvent = event.turnEvent
        turnEvent?.let { demonstrateTurnEventUsage(it) }

Definition at line 75 of file RouteEvent.java.

getType()

RouteEventType com.navigine.idl.java.RouteEvent.getType ( )

inline

Active event variant discriminator.

Returns

Java code snippet:

        // Get event type
        RouteEventType type = event.getType();
        System.out.println("Event type: " + type);

Kotlin code snippet:

        // Get event type
        val type = event.type
        println("Event type: $type")

Definition at line 58 of file RouteEvent.java.

toString()

String com.navigine.idl.java.RouteEvent.toString ( )

inline

Definition at line 131 of file RouteEvent.java.

---

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

• RouteEvent.java