org.opentripplanner.api.resource

Class DebugOutput

java.lang.Object

org.opentripplanner.api.resource.DebugOutput

public class DebugOutput
extends Object

Holds information to be included in the REST Response for debugging and profiling purposes. startedCalculating is called in the routingContext constructor. finishedCalculating and finishedRendering are all called in PlanGenerator.generate(). finishedPrecalculating and foundPaths are called in the SPTService implementations.

Field Summary

Fields

Modifier and Type	Field and Description
long	pathCalculationTime
List<Long>	pathTimes
long	precalculationTime
long	renderingTime
boolean	timedOut
long	totalTime

Constructor Summary

Constructors

Constructor and Description
DebugOutput()

Method Summary

Modifier and Type	Method and Description
void	finishedCalculating() Record the time when we finished calculating paths for this request.
void	finishedPrecalculating() Record the time when we finished heuristic pre-calculation.
void	finishedRendering() Record the time when we finished converting paths into itineraries.
void	foundPath() Record the time when a path was found.
void	startedCalculating() Record the time when we first began calculating a path for this request (before any heuristic pre-calculation).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

precalculationTime

public long precalculationTime

pathCalculationTime

public long pathCalculationTime

pathTimes

public List<Long> pathTimes

renderingTime

public long renderingTime

totalTime

public long totalTime

timedOut

public boolean timedOut

Constructor Detail

DebugOutput

public DebugOutput()

Method Detail

startedCalculating

public void startedCalculating()

Record the time when we first began calculating a path for this request (before any heuristic pre-calculation). Note that timings will not include network and server request queue overhead, which is what we want. finishedPrecalculating is also set because some heuristics will not mark any precalculation step, and path times are measured from when precalculation ends.

finishedPrecalculating

public void finishedPrecalculating()

Record the time when we finished heuristic pre-calculation.

foundPath

public void foundPath()

Record the time when a path was found.

finishedCalculating

public void finishedCalculating()

Record the time when we finished calculating paths for this request.

finishedRendering

public void finishedRendering()

Record the time when we finished converting paths into itineraries.