de.vdv.ojp20.OptimisationMethodEnumeration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5 
// See https://eclipse-ee4j.github.io/jaxb-ri 
// Any modifications to this file will be lost upon recompilation of the source schema. 
//


package de.vdv.ojp20;

import jakarta.xml.bind.annotation.XmlEnum;
import jakarta.xml.bind.annotation.XmlEnumValue;
import jakarta.xml.bind.annotation.XmlType;


/**
 * The types of algorithms that can be used for planning a journey (fastest, least walking, etc.). Only one method can be used. Each one really is a whole set of a policy, which is defined below. E.g., "fastest" also includes "least transfers" as a second criteria, some modes are excluded usually by default. Implementations might differ (slightly). Also, some strategies might not be implemented. The most important strategies are marked.
 * 
 * Java class for OptimisationMethodEnumeration.
 * 
 * The following schema fragment specifies the expected content contained within this class.
 * {@code
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *   
 * 
 * }
 * 
 */
@XmlType(name = "OptimisationMethodEnumeration")
@XmlEnum
public enum OptimisationMethodEnumeration {


    /**
     * Shortest duration somewhere in the future. This may present a shorter trip than the next earliest arrival (with latest departure). Expected strategy.
     * 
     */
    @XmlEnumValue("fastest")
    FASTEST("fastest"),

    /**
     * Minimise the number of interchanges as the first criterion. Expected strategy.
     * 
     */
    @XmlEnumValue("minChanges")
    MIN_CHANGES("minChanges"),

    /**
     * Shortest walking distance in meters, summed over all legs.
     * 
     */
    @XmlEnumValue("leastWalking")
    LEAST_WALKING("leastWalking"),

    /**
     * Cheapest fare, considering the applicable reductions. Might not be based on actual cost, but an estimation. Expected strategy.
     * 
     */
    @XmlEnumValue("leastCost")
    LEAST_COST("leastCost"),

    /**
     * Least distance in metres. Mostly used for ALTERNATIVE MODE OF OPERATION and for ItModesToCover.
     * 
     */
    @XmlEnumValue("leastDistance")
    LEAST_DISTANCE("leastDistance"),

    /**
     * Earliest possible arrival time respecting the time constraints (forward search).
     * 
     */
    @XmlEnumValue("earliestArrival")
    EARLIEST_ARRIVAL("earliestArrival"),

    /**
     * Latest departure time for a given arrival time (backward search).
     * 
     */
    @XmlEnumValue("latestDeparture")
    LATEST_DEPARTURE("latestDeparture"),

    /**
     * Combines earliestArrival and latestDeparture, allowing to compress the departure time (forward-backward-forward search).
     * 
     */
    @XmlEnumValue("earliestArrivalAndLatestDeparture")
    EARLIEST_ARRIVAL_AND_LATEST_DEPARTURE("earliestArrivalAndLatestDeparture"),

    /**
     * The user wants to minimize non-level entrances on the trip. this is useful for PRM who still can use some non-level entrances.
     * 
     */
    @XmlEnumValue("minNonLevelEntrances")
    MIN_NON_LEVEL_ENTRANCES("minNonLevelEntrances"),

    /**
     * The user wants to minimize stairs and steps on the trip. This is useful for PRM who still can use some steps/stairs.
     * 
     */
    @XmlEnumValue("minStairs")
    MIN_STAIRS("minStairs"),

    /**
     * The user wants to avoid transfers without tactile guidance, as well as platforms and vehicles without auditory signals.
     * 
     */
    @XmlEnumValue("bestForVisualImpairment")
    BEST_FOR_VISUAL_IMPAIRMENT("bestForVisualImpairment"),

    /**
     * The user wants to avoid transfers without guidance for people with auditory impairment, as well as platforms and vehicles without visual signs.
     * 
     */
    @XmlEnumValue("bestForAuditoryImpairment")
    BEST_FOR_AUDITORY_IMPAIRMENT("bestForAuditoryImpairment"),

    /**
     * If set, favour "green" modes/lines such as bike sharing and (electric) trains, avoid or restrict modes/lines known for higher CO2 emissions such as (conventional) taxi, ride-hailing or coach.
     * 
     */
    @XmlEnumValue("environmentalSafety")
    ENVIRONMENTAL_SAFETY("environmentalSafety"),

    /**
     * High level of safety (referring to crime, hazards or prone to accidents). If used, certain modes, lines or zones/districts known for lower safety, i.e. higher risk of accidents and crime, may be avoided, others may be preferred. This may depend on the actual, local or time of day situation. E.g. bike or scooter may be considered unsafe in some cities/districts while safe in others.
     * 
     */
    @XmlEnumValue("extraSafe")
    EXTRA_SAFE("extraSafe"),

    /**
     * Low probability of delays, cancellations etc. If used, modes known for their (un)reliability may be avoided/preferred, and extra time added for transfers. This may depend on the actual, local or time of day situation, based on punctuality statics, traffic jam statistics or rush hours. E.g. taxis in a given city might be known to be unreliable during at 8-10 and 16-19 hours, otherwise reliable.
     * 
     */
    @XmlEnumValue("extraReliable")
    EXTRA_RELIABLE("extraReliable"),

    /**
     * Scenic (or touristic) travel. Different by modes or by the surrounding.
     * 
     */
    @XmlEnumValue("scenic")
    SCENIC("scenic"),

    /**
     * E.g. first class or quiet compartments preferred. Journeys that are with low occupancy.
     * 
     */
    @XmlEnumValue("quietTravel")
    QUIET_TRAVEL("quietTravel");
    private final String value;

    OptimisationMethodEnumeration(String v) {
        value = v;
    }

    /**
     * Gets the value associated to the enum constant.
     * 
     * @return
     *     The value linked to the enum.
     */
    public String value() {
        return value;
    }

    /**
     * Gets the enum associated to the value passed as parameter.
     * 
     * @param v
     *     The value to get the enum from.
     * @return
     *     The enum which corresponds to the value, if it exists.
     * @throws IllegalArgumentException
     *     If no value matches in the enum declaration.
     */
    public static OptimisationMethodEnumeration fromValue(String v) {
        for (OptimisationMethodEnumeration c: OptimisationMethodEnumeration.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}