IndividualRaptorParametersForPerson.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 org.matsim.api.core.v01.population.Person;
import org.matsim.core.config.Config;
import org.matsim.core.config.ConfigUtils;
import org.matsim.core.config.groups.ScoringConfigGroup;
import org.matsim.core.scoring.functions.ModeUtilityParameters;
import org.matsim.core.scoring.functions.ScoringParameters;
import org.matsim.core.scoring.functions.ScoringParametersForPerson;

import jakarta.inject.Inject;
import java.util.Map;

public class IndividualRaptorParametersForPerson implements RaptorParametersForPerson {
    private final Config config;
    private final SwissRailRaptorConfigGroup raptorConfig;
    private final ScoringParametersForPerson parametersForPerson;

    @Inject
    public IndividualRaptorParametersForPerson(Config config, ScoringParametersForPerson parametersForPerson) {
        this.config = config;
        this.raptorConfig = ConfigUtils.addOrGetModule(config, SwissRailRaptorConfigGroup.class);
        this.parametersForPerson = parametersForPerson;
    }

    @Override
    public RaptorParameters getRaptorParameters(Person person) {
        RaptorParameters raptorParameters = RaptorUtils.createParameters(config);
        ScoringParameters scoringParameters = parametersForPerson.getScoringParameters(person);

        double marginalUtilityOfPerforming = scoringParameters.marginalUtilityOfPerforming_s;

        raptorParameters.setMarginalUtilityOfWaitingPt_utl_s(
                scoringParameters.marginalUtilityOfWaitingPt_s - marginalUtilityOfPerforming);

        ScoringConfigGroup pcsConfig = config.scoring();

        for (Map.Entry<String, ScoringConfigGroup.ModeParams> e : pcsConfig.getModes().entrySet()) {
            String mode = e.getKey();
            ModeUtilityParameters modeParams = scoringParameters.modeParams.get(mode);

            if (modeParams != null) {
                raptorParameters.setMarginalUtilityOfTravelTime_utl_s(mode,
                        modeParams.marginalUtilityOfTraveling_s - marginalUtilityOfPerforming);
            }
        }

        double costPerHour = this.raptorConfig.getTransferPenaltyCostPerTravelTimeHour();
        if (costPerHour == 0.0) {
            // backwards compatibility, use the default utility of line switch
            raptorParameters.setTransferPenaltyFixCostPerTransfer(-scoringParameters.utilityOfLineSwitch);
        } else {
            raptorParameters.setTransferPenaltyFixCostPerTransfer(this.raptorConfig.getTransferPenaltyBaseCost());
        }
        raptorParameters.setTransferPenaltyPerTravelTimeHour(costPerHour);
        raptorParameters.setTransferPenaltyMinimum(this.raptorConfig.getTransferPenaltyMinCost());
        raptorParameters.setTransferPenaltyMaximum(this.raptorConfig.getTransferPenaltyMaxCost());

        return raptorParameters;
    }
}