org.opentripplanner.model.TransferPriority Maven / Gradle / Ivy

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

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

package org.opentripplanner.model;


/**
 * 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 TransferPriority {
    /**
     * 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,

    /**
     * Allow transfers from/to this stop. This is the default.
     * 

     * NeTEx equivalent is INTERCHANGE_ALLOWED.
     */
    ALLOWED,

    /**
     * Recommended stop place.
     * 

     * NeTEx equivalent is RECOMMENDED_INTERCHANGE.
     */
    RECOMMENDED,

    /**
     * Preferred place to transfer, strongly recommended.
     * 
     * NeTEx equivalent is PREFERRED_INTERCHANGE.
     */
    PREFERRED;
}