PlanRouter.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * PlanRouter.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2012 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */
package org.matsim.core.router;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.population.Leg;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.api.core.v01.population.PlanElement;
import org.matsim.core.population.algorithms.PersonAlgorithm;
import org.matsim.core.population.algorithms.PlanAlgorithm;
import org.matsim.core.population.routes.NetworkRoute;
import org.matsim.core.router.TripStructureUtils.Trip;
import org.matsim.core.utils.timing.TimeInterpretation;
import org.matsim.core.utils.timing.TimeTracker;
import org.matsim.facilities.ActivityFacilities;
import org.matsim.facilities.FacilitiesUtils;
import org.matsim.vehicles.Vehicle;

import java.util.List;

public final class PlanRouter implements PlanAlgorithm, PersonAlgorithm {
    private static final Logger log = LogManager.getLogger( PlanRouter.class ) ;
    private final TripRouter tripRouter;
    private final ActivityFacilities facilities;
    private final TimeInterpretation timeInterpretation;

    public PlanRouter( final TripRouter tripRouter, final ActivityFacilities facilities, final TimeInterpretation timeInterpretation) {
        this.tripRouter = tripRouter;
        this.facilities = facilities;
        this.timeInterpretation = timeInterpretation;
    }

    public PlanRouter( final TripRouter routingHandler, final TimeInterpretation timeInterpretation) {
        this( routingHandler , null, timeInterpretation );
    }

    @Override
    public void run(final Plan plan) {
        final List<Trip> trips = TripStructureUtils.getTrips( plan );
        TimeTracker timeTracker = new TimeTracker(timeInterpretation);

        for (Trip oldTrip : trips) {
            final String routingMode = TripStructureUtils.identifyMainMode( oldTrip.getTripElements() );
            timeTracker.addActivity(oldTrip.getOriginActivity());

            if (log.isDebugEnabled()) log.debug("about to call TripRouter with routingMode=" + routingMode);
            final List<? extends PlanElement> newTripElements = tripRouter.calcRoute( //
                    routingMode, //
                    FacilitiesUtils.toFacility(oldTrip.getOriginActivity(), facilities), //
                    FacilitiesUtils.toFacility(oldTrip.getDestinationActivity(), facilities), //
                    timeTracker.getTime().seconds(), //
                    plan.getPerson(), //
                    oldTrip.getTripAttributes() //
            );

            putVehicleFromOldTripIntoNewTripIfMeaningful(oldTrip, newTripElements);

            TripRouter.insertTrip( plan, oldTrip.getOriginActivity(), newTripElements, oldTrip.getDestinationActivity());

            timeTracker.addElements(newTripElements);
        }
    }

    public static void putVehicleFromOldTripIntoNewTripIfMeaningful(Trip oldTrip, List<? extends PlanElement> newTrip) {
        Id<Vehicle> oldVehicleId = getUniqueVehicleId(oldTrip);
        if (oldVehicleId != null) {
            for (Leg leg : TripStructureUtils.getLegs(newTrip)) {
                if (leg.getRoute() instanceof NetworkRoute) {
                    if (((NetworkRoute) leg.getRoute()).getVehicleId() == null) {
                        ((NetworkRoute) leg.getRoute()).setVehicleId(oldVehicleId);
                    }
                }
            }
        }
    }

    private static Id<Vehicle> getUniqueVehicleId(Trip trip) {
        Id<Vehicle> vehicleId = null;
        for (Leg leg : trip.getLegsOnly()) {
            if (leg.getRoute() instanceof NetworkRoute) {
                if (vehicleId != null && (!vehicleId.equals(((NetworkRoute) leg.getRoute()).getVehicleId()))) {
                    return null; // The trip uses several vehicles.
                }
                vehicleId = ((NetworkRoute) leg.getRoute()).getVehicleId();
            }
        }
        return vehicleId;
    }

    @Override
    public void run(final Person person) {
        for (Plan plan : person.getPlans()) {
            run( plan );
        }
    }

}