TransitRouterConfig.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * TransitRouterConfig.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2009 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.pt.router;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.TransportMode;
import org.matsim.core.api.internal.MatsimParameters;
import org.matsim.core.config.Config;
import org.matsim.core.config.groups.ScoringConfigGroup;
import org.matsim.core.config.groups.RoutingConfigGroup;
import org.matsim.core.config.groups.RoutingConfigGroup.TeleportedModeParams;
import org.matsim.core.config.groups.VspExperimentalConfigGroup;
import org.matsim.core.gbl.Gbl;
import org.matsim.pt.config.TransitRouterConfigGroup;

public class TransitRouterConfig implements MatsimParameters {
    private static final Logger log = LogManager.getLogger( TransitRouterConfig.class ) ;

    private double searchRadius = 1000.0;

    private double extensionRadius = 200.0;

    private double beelineWalkConnectionDistance = 100.0;

    private double additionalTransferTime = 0.0;

    private double beelineWalkSpeed; // meter / second

    private double marginalUtilityOfTravelTimeWalk_utl_s;

    private double marginalUtilityOfTravelTimeTransit_utl_s;

    private double marginalUtilityOfWaitingPt_utl_s;

    private double marginalUtilityOfTravelDistanceWalk_utl_m;

    private double marginalUtilityOfTravelDistanceTransit_utl_m;

    private double utilityOfLineSwitch_utl;

    private Double beelineDistanceFactor;

    private final double directWalkFactor ;

    private boolean cacheTree;

    public TransitRouterConfig(final Config config) {
        this(config.scoring(), config.routing(), config.transitRouter(), config.vspExperimental());
    }

    public TransitRouterConfig(final ScoringConfigGroup pcsConfig, final RoutingConfigGroup routingConfig,
                                                         final TransitRouterConfigGroup trConfig, final VspExperimentalConfigGroup vspConfig )
    {
        pcsConfig.setLocked(); routingConfig.setLocked() ; trConfig.setLocked() ; vspConfig.setLocked() ;

        if (pcsConfig.getScoringParametersPerSubpopulation().size()>1){
            LogManager.getLogger(getClass()).warn("More than one subpopulation is used in plansCalcScore. "
                    + "This is not currently implemented in the TransitRouter (but should work for scoring),"
                    + " so the values for the \"default\" subpopulation will be used. (jb, Feb 2018)");
        }

        // walk:
        {
            TeleportedModeParams params = routingConfig.getTeleportedModeParams().get( TransportMode.transit_walk );
            if ( params==null ) {
                params = routingConfig.getTeleportedModeParams().get( TransportMode.non_network_walk );
            }
            if ( params==null ) {
                params = routingConfig.getTeleportedModeParams().get( TransportMode.walk) ;
            }
            if ( params==null ) {
                log.error( "teleported mode params do not exist for " + TransportMode.transit_walk + ", " + TransportMode.non_network_walk + ", nor "
                + TransportMode.walk + ".  At least one of them needs to be defined for TransitRouterConfig.  Aborting ...");
                // yyyy I do not know which of this is conceptually the correct one.  It should _not_ be walk since that may be routed on the network, see below.  kai, mar'25
            }
            Gbl.assertNotNull( params );
            this.beelineDistanceFactor = params.getBeelineDistanceFactor();
            this.beelineWalkSpeed = params.getTeleportedModeSpeed() / beelineDistanceFactor;
        }
        // yyyyyy the two above need to be moved away from walk since otherwise one is not able to move walk routing to network routing!!!!!! Now trying access_walk ...  kai,
        // apr'19

        this.marginalUtilityOfTravelTimeWalk_utl_s = pcsConfig.getModes().get(TransportMode.walk).getMarginalUtilityOfTraveling() /3600.0 - pcsConfig.getPerforming_utils_hr()/3600. ;

        this.marginalUtilityOfTravelDistanceWalk_utl_m = pcsConfig.getMarginalUtilityOfMoney() *
                pcsConfig.getModes().get(TransportMode.walk).getMonetaryDistanceRate() +
                pcsConfig.getModes().get(TransportMode.walk).getMarginalUtilityOfDistance();

        // pt:
        this.marginalUtilityOfTravelTimeTransit_utl_s = pcsConfig.getModes().get(TransportMode.pt).getMarginalUtilityOfTraveling() /3600.0 - pcsConfig.getPerforming_utils_hr()/3600. ;

        this.marginalUtilityOfTravelDistanceTransit_utl_m = pcsConfig.getMarginalUtilityOfMoney() *
                pcsConfig.getModes().get(TransportMode.pt).getMonetaryDistanceRate() +
                pcsConfig.getModes().get(TransportMode.pt).getMarginalUtilityOfDistance();

        this.marginalUtilityOfWaitingPt_utl_s = pcsConfig.getMarginalUtlOfWaitingPt_utils_hr() / 3600.0 - pcsConfig.getPerforming_utils_hr()/3600. ;

        this.utilityOfLineSwitch_utl = pcsConfig.getUtilityOfLineSwitch();

        // router:
        this.setSearchRadius(trConfig.getSearchRadius());
        this.setExtensionRadius(trConfig.getExtensionRadius());
        this.setBeelineWalkConnectionDistance(trConfig.getMaxBeelineWalkConnectionDistance());
        this.setAdditionalTransferTime(trConfig.getAdditionalTransferTime());
        this.directWalkFactor = trConfig.getDirectWalkFactor() ;
        this.cacheTree = trConfig.isCacheTree();
    }

    public void setUtilityOfLineSwitch_utl(final double utilityOfLineSwitch_utl_sec) {
        this.utilityOfLineSwitch_utl = utilityOfLineSwitch_utl_sec;
    }

    public double getUtilityOfLineSwitch_utl() {
        return this.utilityOfLineSwitch_utl;
    }

    public void setMarginalUtilityOfTravelTimeWalk_utl_s(final double marginalUtilityOfTravelTimeWalk_utl_s) {
        this.marginalUtilityOfTravelTimeWalk_utl_s = marginalUtilityOfTravelTimeWalk_utl_s;
    }

    public double getMarginalUtilityOfTravelTimeWalk_utl_s() {
        return this.marginalUtilityOfTravelTimeWalk_utl_s;
    }

    public void setMarginalUtilityOfTravelTimePt_utl_s(final double marginalUtilityOfTravelTimeTransit_utl_s) {
        this.marginalUtilityOfTravelTimeTransit_utl_s = marginalUtilityOfTravelTimeTransit_utl_s;
    }

    public void setMarginalUtilityOfTravelDistanceWalk_utl_m(final double marginalUtilityOfTravelDistanceWalk_utl_m) {
        this.marginalUtilityOfTravelDistanceWalk_utl_m = marginalUtilityOfTravelDistanceWalk_utl_m;
    }

    public double getMarginalUtilityOfTravelTimePt_utl_s() {
        return this.marginalUtilityOfTravelTimeTransit_utl_s;
    }

    public void setMarginalUtilityOfTravelDistancePt_utl_m(final double marginalUtilityOfTravelDistanceTransit_utl_m) {
        this.marginalUtilityOfTravelDistanceTransit_utl_m = marginalUtilityOfTravelDistanceTransit_utl_m;
    }

    public double getMarginalUtilityOfWaitingPt_utl_s() {
        return this.marginalUtilityOfWaitingPt_utl_s;
    }

    public void setMarginalUtilityOfWaitingPt_utl_s(final double effectiveMarginalUtilityOfWaiting_utl_s) {
        this.marginalUtilityOfWaitingPt_utl_s = effectiveMarginalUtilityOfWaiting_utl_s;
    }

    public double getMarginalUtilityOfTravelDistancePt_utl_m() {
        return this.marginalUtilityOfTravelDistanceTransit_utl_m;
    }

    public double getMarginalUtilityOfTravelDistanceWalk_utl_m() {
        return this.marginalUtilityOfTravelDistanceWalk_utl_m;
    }

    public void setBeelineWalkSpeed(final double beelineWalkSpeed) {
        this.beelineWalkSpeed = beelineWalkSpeed;
    }

    public double getBeelineWalkSpeed() {
        return this.beelineWalkSpeed;
    }

    public double getSearchRadius() {
        return searchRadius;
    }

    public void setSearchRadius(double searchRadius) {
        this.searchRadius = searchRadius;
    }

    public double getExtensionRadius() {
        return extensionRadius;
    }

    public void setExtensionRadius(double extensionRadius) {
        this.extensionRadius = extensionRadius;
    }

    public double getBeelineWalkConnectionDistance() {
        return beelineWalkConnectionDistance;
    }

    public void setBeelineWalkConnectionDistance(double beelineWalkConnectionDistance) {
        this.beelineWalkConnectionDistance = beelineWalkConnectionDistance;
    }

    public double getAdditionalTransferTime() {
        return additionalTransferTime;
    }

    public void setAdditionalTransferTime(double additionalTransferTime) {
        this.additionalTransferTime = additionalTransferTime;
    }

    public final Double getBeelineDistanceFactor() {
        return this.beelineDistanceFactor;
    }

    public double getDirectWalkFactor() {
        return this.directWalkFactor ;
    }

    public boolean isCacheTree() {
        return cacheTree;
    }

    public void setCacheTree(boolean cacheTree) {
        this.cacheTree = cacheTree;
    }
}