org.opentripplanner.routing.edgetype.BikeWalkableEdge Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.5.0
package org.opentripplanner.routing.edgetype;

import org.opentripplanner.routing.api.request.RoutingRequest;
import org.opentripplanner.routing.core.State;
import org.opentripplanner.routing.core.StateEditor;
import org.opentripplanner.routing.core.TraverseMode;
import org.opentripplanner.routing.graph.Edge;

public interface BikeWalkableEdge {

    default boolean canSwitchToWalkingBike(State state) {
        return state.getNonTransitMode() == TraverseMode.BICYCLE;
    }

    default void switchToWalkingBike(
            RoutingRequest options,
            StateEditor editor
    ) {
        // If this is the first traversed edge than the bikeSwitch cost doesn't need to be applied
        var parentState = editor.getBackState();
        var shouldIncludeCost = !parentState.isBackWalkingBike() && hadBackModeSet(parentState);

        editor.setBackWalkingBike(true);
        if (shouldIncludeCost) {
            editor.incrementWeight(options.bikeSwitchCost);
            editor.incrementTimeInSeconds(options.bikeSwitchTime);
        }
    }

    default void switchToBiking(RoutingRequest options, StateEditor editor) {
        var parentState = editor.getBackState();
        var shouldIncludeCost = parentState.isBackWalkingBike();

        editor.setBackWalkingBike(false);
        if (shouldIncludeCost) {
            editor.incrementWeight(options.bikeSwitchCost);
            editor.incrementTimeInSeconds(options.bikeSwitchTime);
        }
    }

    default boolean hadBackModeSet(State state) {
        do {
            if (state.getBackMode() != null) {
                return state.getBackMode().isOnStreetNonTransit();
            }
            state = state.getBackState();
        } while (state != null);

        return false;
    }

    default StateEditor createEditorForDrivingOrWalking(State s0, Edge edge) {
        if (s0.getNonTransitMode() == TraverseMode.CAR) {
            return s0.edit(edge);
        }

        return createEditor(s0, edge, TraverseMode.WALK, s0.getNonTransitMode() == TraverseMode.BICYCLE);
    }

    default StateEditor createEditorForWalking(State s0, Edge edge) {
        if (s0.getNonTransitMode() == TraverseMode.CAR) {
            return null;
        }

        return createEditor(s0, edge, TraverseMode.WALK, s0.getNonTransitMode() == TraverseMode.BICYCLE);
    }

    default StateEditor createEditor(State s0, Edge edge, TraverseMode mode, boolean bicycleWalking) {
        StateEditor editor = s0.edit(edge);

        if (bicycleWalking) {
            if (canSwitchToWalkingBike(s0)) {
                switchToWalkingBike(s0.getOptions(), editor);
            }
            else {
                return null;
            }
        }
        else if (mode == TraverseMode.BICYCLE) {
            switchToBiking(s0.getOptions(), editor);
        }

        editor.setBackMode(mode);

        return editor;
    }
}