ScoringFunction.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * ScoringFunction.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007 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.scoring;

import org.matsim.api.core.v01.events.Event;
import org.matsim.api.core.v01.events.PersonMoneyEvent;
import org.matsim.api.core.v01.events.PersonScoreEvent;
import org.matsim.api.core.v01.population.Activity;
import org.matsim.api.core.v01.population.Leg;
import org.matsim.core.router.TripStructureUtils;

public interface ScoringFunction {

    void handleActivity(Activity activity);

    void handleLeg(Leg leg);

    void agentStuck(final double time);

    void addMoney(final double amount);

    void addScore(final double amount);

    void finish();

    double getScore();

    void handleEvent( Event event ) ;

    default void handleTrip( TripStructureUtils.Trip trip ) {
        // empty default implementation, since older implementations of the interface
        // don't have this method, and work happily without. kai, sep'18
    }

    default void explainScore(StringBuilder out) {
    }

    String SCORE_DELIMITER = ";";
    String SCORE_EXPLANATION_ATTR = "scoreExplanation";

}