org.transitime.ipc.data

Class IpcPredictionsForRouteStopDest

java.lang.Object

org.transitime.ipc.data.IpcPredictionsForRouteStopDest

All Implemented Interfaces:

java.io.Serializable

public class IpcPredictionsForRouteStopDest
extends java.lang.Object
implements java.io.Serializable

Contains list of predictions for a route/stop/destination.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IpcPredictionsForRouteStopDest(java.lang.String routeShortName, java.lang.String stopId, java.lang.String directionId, double distanceToStop) For constructing IpcPredictionsForRouteStopDest object when there are no current predictions.
IpcPredictionsForRouteStopDest(TripPattern tripPattern, java.lang.String stopId, double distanceToStop) For constructing an IpcPredictionsForRouteStopDest for when there aren't any predictions.
IpcPredictionsForRouteStopDest(Trip trip, java.lang.String stopId, double distanceToStop) Constructor for creating a IpcPredictionsForRouteStopDest on the server side.

Method Summary

Modifier and Type	Method and Description
IpcPredictionsForRouteStopDest	getClone(int maxPredictionsPerStop, double distanceToStop) Gets a copy of this object.
IpcPredictionsForRouteStopDest	getClone(int maxPredictionsPerStop, long maxSystemTimeForPrediction, double distanceToStop) Gets a copy of this object.
java.lang.String	getDirectionId()
double	getDistanceToStop() Distance from location to the stop if getting predictions by location.
java.lang.String	getHeadsign()
java.util.List<IpcPrediction>	getPredictionsForRouteStop()
java.lang.String	getRouteId()
java.lang.String	getRouteName()
int	getRouteOrder()
java.lang.String	getRouteShortName()
java.lang.String	getStopId()
java.lang.String	getStopName()
void	removeExpiredPredictions(long currentTime) Removes predictions that are older than the current time.
void	removePrediction(IpcPrediction oldPrediction) Removes a prediction.
java.lang.String	toShortString() Intended for debugging
java.lang.String	toString()
void	updatePredictionsForVehicle(java.util.List<IpcPrediction> newPredsForRouteStopDest, long currentTime) Updates the predictions for this object with the new predictions for a vehicle.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IpcPredictionsForRouteStopDest

public IpcPredictionsForRouteStopDest(Trip trip,
                                      java.lang.String stopId,
                                      double distanceToStop)

Constructor for creating a IpcPredictionsForRouteStopDest on the server side.

Parameters:

trip -

stopId -

distanceToStop - How far stop is away from user. If predictions are not location based then use value of Double.NaN.

IpcPredictionsForRouteStopDest

public IpcPredictionsForRouteStopDest(TripPattern tripPattern,
                                      java.lang.String stopId,
                                      double distanceToStop)

For constructing an IpcPredictionsForRouteStopDest for when there aren't any predictions.

Parameters:

tripPattern - Must not be null

stopId -

distanceToStop -

IpcPredictionsForRouteStopDest

public IpcPredictionsForRouteStopDest(java.lang.String routeShortName,
                                      java.lang.String stopId,
                                      java.lang.String directionId,
                                      double distanceToStop)

For constructing IpcPredictionsForRouteStopDest object when there are no current predictions.

Parameters:

routeShortName -

stopId -

directionId -

distanceToStop -

Method Detail

getClone

public IpcPredictionsForRouteStopDest getClone(int maxPredictionsPerStop,
                                               double distanceToStop)

Gets a copy of this object. This is done with the object being copied synchronized so that the predictions remain coherent. Limits number of predictions to maxPredictionsPerStop.

Parameters:

maxPredictionsPerStop -

distanceFromStop - For when getting predictions by location

Returns:

getClone

public IpcPredictionsForRouteStopDest getClone(int maxPredictionsPerStop,
                                               long maxSystemTimeForPrediction,
                                               double distanceToStop)

Gets a copy of this object. This is done with the object being copied synchronized so that the predictions remain coherent. Limits number of predictions to maxPredictionsPerStop.

Parameters:

maxPredictionsPerStop - Won't copy more then this number of predictions

maxSystemTimeForPrediction - Max point in future want predictions for. This way can limit predictions when requesting a large number of them.

distanceToStop - For when getting predictions by location

Returns:

removePrediction

public void removePrediction(IpcPrediction oldPrediction)

Removes a prediction.

Not sure if really need to synchronize removal of predictions from list since it is only a single operation. But synching it is certainly the safe thing to do.

Parameters:

oldPrediction -

removeExpiredPredictions

public void removeExpiredPredictions(long currentTime)

Removes predictions that are older than the current time. Useful for when getting predictions. Synchronized because don't want predictions list to be changing by another thread when removing predictions.

Parameters:

currentTime - Should use PredictionDataCache.systemTime.get() so that works even when in playback mode.

updatePredictionsForVehicle

public void updatePredictionsForVehicle(java.util.List<IpcPrediction> newPredsForRouteStopDest,
                                        long currentTime)

Updates the predictions for this object with the new predictions for a vehicle.

Synchronized because there are multiple steps in removing old predictions and creating new ones.

Parameters:

newPredsForRouteStopDest - The new predictions for the vehicle

currentTime - So can get rid of predictions that have expired.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toShortString

public java.lang.String toShortString()

Intended for debugging

Returns:

getRouteId

public java.lang.String getRouteId()

getRouteShortName

public java.lang.String getRouteShortName()

getRouteName

public java.lang.String getRouteName()

getStopId

public java.lang.String getStopId()

getStopName

public java.lang.String getStopName()

getHeadsign

public java.lang.String getHeadsign()

getDirectionId

public java.lang.String getDirectionId()

getDistanceToStop

public double getDistanceToStop()

Distance from location to the stop if getting predictions by location. Otherwise will return Double.NaN.

Returns:

getPredictionsForRouteStop

public java.util.List<IpcPrediction> getPredictionsForRouteStop()

getRouteOrder

public int getRouteOrder()