XY2Links.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * XY2Links.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 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.population.algorithms;

import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.network.Link;
import org.matsim.api.core.v01.network.Network;
import org.matsim.api.core.v01.population.Activity;
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.gbl.Gbl;
import org.matsim.core.network.NetworkUtils;
import org.matsim.facilities.ActivityFacilities;
import org.matsim.facilities.ActivityFacility;

import java.util.List;
import java.util.Objects;

public final class XY2Links extends AbstractPersonAlgorithm implements PlanAlgorithm {

    private final Network network;
    private final ActivityFacilities activityFacilities;

    public XY2Links(final Network network, final ActivityFacilities activityFacilities ) {
        super();
        this.network = network;
        this.activityFacilities = activityFacilities;
    }

    public XY2Links(final Scenario scenario) {
        this(scenario.getNetwork(), scenario.getActivityFacilities());
    }
    
    @Override
    public void run(final Person person) {
        for (Plan plan : person.getPlans()) {
            processPlan(plan);
        }
    }

    @Override
    public void run(final Plan plan) {
        processPlan(plan);
    }

    private void processPlan(final Plan plan) {
        Objects.requireNonNull( this.activityFacilities ) ;
        List<PlanElement> planElements = plan.getPlanElements();
        for (PlanElement planElement : planElements) {
            if (planElement instanceof Activity) {
                Activity act = (Activity) planElement;
                
                if ( this.activityFacilities != null ) {
                    // since the facilities in Scenario are now permanently enabled, this can only happen when called through the
                    // more specific constructor. kai, feb'16
                    
                        //following is not necessary. Kai, Amit July'18
//                  if (act.getFacilityId() != null) {
//                      ActivityFacility facility = facilities.getFacilities().get(act.getFacilityId());
//                      if (facility != null) {
//                          act.setLinkId(facility.getLinkId());
//                          // yy facility.getLinkId may be null, in particular since linkId is not even part of the facilities DTD. kai, feb'16
//                          // right, just had such a situation in CarSharingIT test. Amit Jul'18
//
//                          if (act.getLinkId() == null && act.getCoord()==null){
//                              // for FacilitiesSource.onePerActivityLocationInPlansFile, one can opt to keep coords in facility only. Amit Jan'18
//                              act.setCoord(facility.getCoord());
//                          }
//                      }
//                  }
                }
                
                if ( act.getLinkId() != null ) {
                    // there may be activities in a plan that have a link and others that have a coordinate.  
                    // Those that have a link do not need a new link.  In addition, they may not even have a 
                    // coordinate.  kai/dominik, nov'11
                    continue ;
                }

                if ( act.getCoord() == null ) {
                    Gbl.assertNotNull( act.getFacilityId() );
                    final ActivityFacility activityFacility = this.activityFacilities.getFacilities().get( act.getFacilityId() );
                    Gbl.assertNotNull( activityFacility );
                    act.setCoord( activityFacility.getCoord() ) ;
                }

                // If the linkId is still null get nearest link from the network
//              Link link = this.network.getNearestLinkExactly(act.getCoord());
                Link link = NetworkUtils.getNearestLink(this.network, act.getCoord());
                // getNearestLinkExactly not necessarily better than getNearestLink.  E.g.
                // n--n-----------------------------n
                // A home location slightly to the right of the middle node will take:
                // * the left link with getNearestLink
                // * the right link with getNearestLinkExactly
                // kai/dominik, jan'13
                /* ownPrepareForSimExample in matsim tutorials gives an example how to use
                 * getNearestLinkExactly . tt feb'2016
                 */
                
                if (null == link) {
                    throw new RuntimeException("For person id="+plan.getPerson().getId()+": getNearestLink returned Null! act="+act);
                }
                act.setLinkId(link.getId());                
            }
        }
    }
}