org.opentripplanner.routing.api.request.preference.VehicleWalkingPreferences Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of application Show documentation
The newest version!
package org.opentripplanner.routing.api.request.preference;

import java.io.Serializable;
import java.time.Duration;
import java.util.Objects;
import java.util.function.Consumer;
import org.opentripplanner.framework.model.Cost;
import org.opentripplanner.framework.model.Units;
import org.opentripplanner.utils.tostring.ToStringBuilder;

/**
 * Preferences for walking a vehicle.
 * 
 * THIS CLASS IS IMMUTABLE AND THREAD-SAFE.
 */
public class VehicleWalkingPreferences implements Serializable {

  public static final VehicleWalkingPreferences DEFAULT = new VehicleWalkingPreferences();

  private final double speed;
  private final double reluctance;
  private final Duration mountDismountTime;
  private final Cost mountDismountCost;
  private final double stairsReluctance;

  private VehicleWalkingPreferences() {
    this.speed = 1.33;
    this.reluctance = 5.0;
    this.mountDismountTime = Duration.ZERO;
    this.mountDismountCost = Cost.ZERO;
    // very high reluctance to carry the bike up/down a flight of stairs
    this.stairsReluctance = 10;
  }

  /**
   * Sets the vehicle walking preferences, does some input value validation and rounds
   * reluctances and speed to not have too many decimals.
   */
  private VehicleWalkingPreferences(Builder builder) {
    this.speed = Units.speed(builder.speed);
    this.reluctance = Units.reluctance(builder.reluctance);
    this.mountDismountTime = Duration.ofSeconds(Units.duration(builder.mountDismountTime));
    this.mountDismountCost = Cost.costOfSeconds(builder.mountDismountCost);
    this.stairsReluctance = Units.reluctance(builder.stairsReluctance);
  }

  public static VehicleWalkingPreferences.Builder of() {
    return new VehicleWalkingPreferences.Builder(DEFAULT);
  }

  public VehicleWalkingPreferences.Builder copyOf() {
    return new VehicleWalkingPreferences.Builder(this);
  }

  /**
   * The walking speed when walking a vehicle. Default: 1.33 m/s ~ Same as walkSpeed.
   */
  public double speed() {
    return speed;
  }

  /**
   * A multiplier for how bad walking is, compared to being in transit for equal
   * lengths of time. Empirically, values between 2 and 4 seem to correspond
   * well to the concept of not wanting to walk too much without asking for
   * totally ridiculous itineraries, but this observation should in no way be
   * taken as scientific or definitive. Your mileage may vary. See
   * https://github.com/opentripplanner/OpenTripPlanner/issues/4090 for impact on
   * performance with high values. Default value: 2.0
   */
  public double reluctance() {
    return reluctance;
  }

  /** Time to get on and off your own vehicle. */
  public Duration mountDismountTime() {
    return mountDismountTime;
  }

  /** Cost of getting on and off your own vehicle. */
  public Cost mountDismountCost() {
    return mountDismountCost;
  }

  /** Reluctance of walking carrying a vehicle up a flight of stairs. */
  public double stairsReluctance() {
    return stairsReluctance;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    VehicleWalkingPreferences that = (VehicleWalkingPreferences) o;
    return (
      speed == that.speed &&
      reluctance == that.reluctance &&
      Objects.equals(mountDismountTime, that.mountDismountTime) &&
      Objects.equals(mountDismountCost, that.mountDismountCost) &&
      stairsReluctance == that.stairsReluctance
    );
  }

  @Override
  public int hashCode() {
    return Objects.hash(speed, reluctance, mountDismountTime, mountDismountCost, stairsReluctance);
  }

  @Override
  public String toString() {
    return ToStringBuilder.of(VehicleWalkingPreferences.class)
      .addNum("speed", speed, DEFAULT.speed)
      .addNum("reluctance", reluctance, DEFAULT.reluctance)
      .addObj("mountDismountTime", mountDismountTime, DEFAULT.mountDismountTime)
      .addObj("mountDismountCost", mountDismountCost, DEFAULT.mountDismountCost)
      .addNum("stairsReluctance", stairsReluctance, DEFAULT.stairsReluctance)
      .toString();
  }

  public static class Builder {

    private final VehicleWalkingPreferences original;
    private double speed;
    private double reluctance;
    private int mountDismountTime;
    private int mountDismountCost;
    private double stairsReluctance;

    private Builder(VehicleWalkingPreferences original) {
      this.original = original;
      this.speed = original.speed;
      this.reluctance = original.reluctance;
      this.mountDismountTime = (int) original.mountDismountTime.toSeconds();
      this.mountDismountCost = original.mountDismountCost.toSeconds();
      this.stairsReluctance = original.stairsReluctance;
    }

    public VehicleWalkingPreferences.Builder withSpeed(double speed) {
      this.speed = speed;
      return this;
    }

    public VehicleWalkingPreferences.Builder withReluctance(double reluctance) {
      this.reluctance = reluctance;
      return this;
    }

    public VehicleWalkingPreferences.Builder withMountDismountTime(Duration mountDismountTime) {
      this.mountDismountTime = (int) mountDismountTime.toSeconds();
      return this;
    }

    public VehicleWalkingPreferences.Builder withMountDismountTime(int mountDismountTime) {
      this.mountDismountTime = mountDismountTime;
      return this;
    }

    public VehicleWalkingPreferences.Builder withMountDismountCost(int mountDismountCost) {
      this.mountDismountCost = mountDismountCost;
      return this;
    }

    public VehicleWalkingPreferences.Builder withStairsReluctance(double stairsReluctance) {
      this.stairsReluctance = stairsReluctance;
      return this;
    }

    public VehicleWalkingPreferences original() {
      return original;
    }

    public VehicleWalkingPreferences.Builder apply(
      Consumer body
    ) {
      body.accept(this);
      return this;
    }

    public VehicleWalkingPreferences build() {
      var newObj = new VehicleWalkingPreferences(this);
      return original.equals(newObj) ? original : newObj;
    }
  }
}