RaptorParameters.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*                                                   *
 *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2023 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 ch.sbb.matsim.routing.pt.raptor;

import ch.sbb.matsim.config.SwissRailRaptorConfigGroup;

import java.util.HashMap;
import java.util.Map;

public class RaptorParameters {

    private double searchRadius = 1000.0;

    private double extensionRadius = 200.0;

    private double directWalkFactor = 1.0;

    private double beelineWalkSpeed; // meter / second

    private final Map<String, Double> marginalUtilityOfTravelTime_utl_s = new HashMap<>();

    private double marginalUtilityOfWaitingPt_utl_s;

    private double transferPenaltyFixCostPerTransfer = 0.0;
    private double transferPenaltyPerTravelTimeHour = 0.0;
    private double transferPenaltyMinimum = Double.NEGATIVE_INFINITY;
    private double transferPenaltyMaximum = Double.POSITIVE_INFINITY;

    private boolean useTransportModeUtilities = false;

    private final SwissRailRaptorConfigGroup config;

    private int maxTransfers = Integer.MAX_VALUE;
    private boolean exactDeparturesOnly = false;

    public RaptorParameters(SwissRailRaptorConfigGroup config) {
        this.config = config;
    }

    public SwissRailRaptorConfigGroup getConfig() {
        return config;
    }

    public double getSearchRadius() {
        return this.searchRadius;
    }

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

    public double getExtensionRadius() {
        return this.extensionRadius;
    }

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

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

    public void setDirectWalkFactor(double directWalkFactor) {
        this.directWalkFactor = directWalkFactor;
    }

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

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

    public double getMarginalUtilityOfTravelTime_utl_s(String mode) {
        Double marginalUtility = this.marginalUtilityOfTravelTime_utl_s.get(mode);
        if (marginalUtility == null) {
            throw new NullPointerException("Marginal utility of travel time is missing for mode: " + mode);
        }
        return marginalUtility;
    }

    public void setMarginalUtilityOfTravelTime_utl_s(String mode, double marginalUtilityOfTravelTime_utl_s) {
        this.marginalUtilityOfTravelTime_utl_s.put(mode, marginalUtilityOfTravelTime_utl_s);
    }

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

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

    public double getTransferPenaltyFixCostPerTransfer() {
        return transferPenaltyFixCostPerTransfer;
    }

    public void setTransferPenaltyFixCostPerTransfer(double transferPenaltyFixCostPerTransfer) {
        this.transferPenaltyFixCostPerTransfer = transferPenaltyFixCostPerTransfer;
    }

    public double getTransferPenaltyPerTravelTimeHour() {
        return this.transferPenaltyPerTravelTimeHour;
    }

    public void setTransferPenaltyPerTravelTimeHour(double transferPenaltyPerTravelTimeHour) {
        this.transferPenaltyPerTravelTimeHour = transferPenaltyPerTravelTimeHour;
    }

    public double getTransferPenaltyMinimum() {
        return this.transferPenaltyMinimum;
    }

    public void setTransferPenaltyMinimum(double transferPenaltyMinimum) {
        this.transferPenaltyMinimum = transferPenaltyMinimum;
    }

    public double getTransferPenaltyMaximum() {
        return this.transferPenaltyMaximum;
    }

    public void setTransferPenaltyMaximum(double transferPenaltyMaximum) {
        this.transferPenaltyMaximum = transferPenaltyMaximum;
    }

    public boolean isUseTransportModeUtilities() {
        return useTransportModeUtilities;
    }

    public void setUseTransportModeUtilities(boolean useTransportModeUtilities) {
        this.useTransportModeUtilities = useTransportModeUtilities;
    }

    int getMaxTransfers() {
        return this.maxTransfers;
    }

    public void setMaxTransfers(int maxTransfers) {
        this.maxTransfers = maxTransfers;
    }

    boolean isExactDeparturesOnly() {
        return this.exactDeparturesOnly;
    }

    void setExactDeparturesOnly(boolean exactDeparturesOnly) {
        this.exactDeparturesOnly = exactDeparturesOnly;
    }
}