org.opentripplanner.api.resource.DebugOutput 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.api.resource;

/**
 * Holds information to be included in the REST Response for debugging and profiling purposes.
 */
public class DebugOutput {

    /**
     * Time taken for worker initialization in milliseconds.
     */
    public final long precalculationTime;

    /**
     * Time taken in the direct street router in milliseconds.
     */
    public final long directStreetRouterTime;

    /**
     * Time taken in the transit router (including access/egress street router) in milliseconds.
     * Detailed timing information within the transit router is sored in transitRouterTimes.
     *
     * @see DebugOutput#transitRouterTimes;
     */
    public final long transitRouterTime;

    /**
     * Time taken in sorting and filtering of the itineraries from the direct and transit routers in
     * milliseconds.
     */
    public final long filteringTime;

    /**
     * Time taken for the mapping of the internal classes to the api classes in milliseconds.
     */
    public final long renderingTime;

    /**
     * Total time taken for the route request in milliseconds.
     */
    public final long totalTime;

    /**
     * Detailed timing information of within the transit router.
     */
    public final TransitTimingOutput transitRouterTimes;

    public DebugOutput(
        long precalculationTime, long directStreetRouterTime, long transitRouterTime,
        long filteringTime, long renderingTime, long totalTime,
        TransitTimingOutput transitRouterTimes
    ) {
        this.precalculationTime = precalculationTime;
        this.directStreetRouterTime = directStreetRouterTime;
        this.transitRouterTime = transitRouterTime;
        this.filteringTime = filteringTime;
        this.renderingTime = renderingTime;
        this.totalTime = totalTime;
        this.transitRouterTimes = transitRouterTimes;
    }

}