org.opentripplanner.ext.flex.flexpathcalculator.FlexPath Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

The newest version!

package org.opentripplanner.ext.flex.flexpathcalculator;

import java.time.Duration;
import java.util.function.Supplier;
import javax.annotation.concurrent.Immutable;
import org.locationtech.jts.geom.LineString;
import org.opentripplanner.framework.lang.IntUtils;
import org.opentripplanner.routing.api.request.framework.TimePenalty;

/**
 * This class contains the results from a FlexPathCalculator.
 */
@Immutable
public class FlexPath {

  private final Supplier geometrySupplier;
  public final int distanceMeters;
  public final int durationSeconds;
  private LineString geometry;

  /**
   * @param geometrySupplier Computing a linestring from a GraphPath is a surprisingly expensive
   *                         operation and since there are very many instances of these for a flex
   *                         access/egress search the actual computation is delayed until the
   *                         linestring is actually needed. Most of them are _not_ needed so this
   *                         increases performance quite dramatically.
   */
  public FlexPath(int distanceMeters, int durationSeconds, Supplier geometrySupplier) {
    this.distanceMeters = distanceMeters;
    this.durationSeconds = IntUtils.requireNotNegative(durationSeconds);
    this.geometrySupplier = geometrySupplier;
  }

  public LineString getGeometry() {
    if (geometry == null) {
      geometry = geometrySupplier.get();
    }
    return geometry;
  }

  /**
   * Returns an (immutable) copy of this path with the duration modified.
   */
  public FlexPath withTimePenalty(TimePenalty penalty) {
    int updatedDuration = (int) penalty.calculate(Duration.ofSeconds(durationSeconds)).toSeconds();
    return new FlexPath(distanceMeters, updatedDuration, geometrySupplier);
  }
}