org.opentripplanner.transit.model.site.StopTransferPriority 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.transit.model.site;

/**
 * Categorize how suitable a Station or Transfer is it for transfer. The values arrange stops from
 * transfer DISCOURAGED to PREFERRED. First of all this should encourage transfers between two
 * trips/routes to happen at the best possible location if there are multiple stop to choose from.
 * But, it will also apply to score a journey over another one, if one of the journeys score better
 * on the transfers, and they have the same cost.
 */
public enum StopTransferPriority {
  /**
   * Preferred place to transfer, strongly recommended.
   * 
   * NeTEx equivalent is PREFERRED_INTERCHANGE.
   */
  PREFERRED,
  /**
   * Recommended stop place.
   * 

   * NeTEx equivalent is RECOMMENDED_INTERCHANGE.
   */
  RECOMMENDED,
  /**
   * Allow transfers from/to this stop. This is the default.
   * 

   * NeTEx equivalent is INTERCHANGE_ALLOWED.
   */
  ALLOWED,
  /**
   * Block transfers from/to this stop. In OTP this is not a definitive block, just a huge penalty
   * is added to the cost function.
   * 
   * NeTEx equivalent is NO_INTERCHANGE.
   */
  DISCOURAGED;

  /**
   * The {@link #ALLOWED} is used as default value in cases where the value is not set.
   */
  public static StopTransferPriority defaultValue() {
    return ALLOWED;
  }
}