org.transitime.ipc.data

Class IpcPrediction

java.lang.Object

org.transitime.ipc.data.IpcPrediction

All Implemented Interfaces:

java.io.Serializable

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

Contains information on a single prediction. For providing info to client.

Declared serializable since using RMI to pass back Prediction objects and RMI uses serialization.

Author:

SkiBu Smith

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IpcPrediction.ArrivalOrDeparture

Constructor Summary

Constructors

Constructor and Description
IpcPrediction(AvlReport avlReport, java.lang.String stopId, int gtfsStopSeq, Trip trip, long predictionTime, long actualPredictionTime, boolean atEndOfTrip, boolean predictionAffectedByWaitStop, boolean isDelayed, boolean lateAndSubsequentTripSoMarkAsUncertain, IpcPrediction.ArrivalOrDeparture arrivalOrDeparture) Constructs a Prediction object.

Method Summary

Modifier and Type	Method and Description
long	getActualPredictionTime()
long	getAvlTime()
java.lang.String	getBlockId()
long	getCreationTime()
java.lang.String	getDriverId() Returns the driver ID if it is available.
int	getGtfsStopSeq()
short	getPassengerCount() Returns the passenger count as obtained from the AVL feed.
long	getPredictionTime()
java.lang.String	getRouteId()
java.lang.String	getRouteShortName() Returns the short name for the route associated with the prediction.
java.lang.String	getStopId()
Trip	getTrip() Returns the trip associated with the prediction.
java.lang.String	getTripId()
java.lang.String	getTripPatternId()
long	getTripStartEpochTime()
java.lang.String	getVehicleId()
boolean	isAffectedByWaitStop()
boolean	isArrival()
boolean	isAtEndOfTrip()
boolean	isDelayed()
boolean	isLateAndSubsequentTripSoMarkAsUncertain() For when vehicle is quite late and prediction is for a subsequent trip.
boolean	isPassengerCountValid() Passenger counts only valid for systems where there actually are passenger counting sensors.
boolean	isSchedBasedPred()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpcPrediction

public IpcPrediction(AvlReport avlReport,
                     java.lang.String stopId,
                     int gtfsStopSeq,
                     Trip trip,
                     long predictionTime,
                     long actualPredictionTime,
                     boolean atEndOfTrip,
                     boolean predictionAffectedByWaitStop,
                     boolean isDelayed,
                     boolean lateAndSubsequentTripSoMarkAsUncertain,
                     IpcPrediction.ArrivalOrDeparture arrivalOrDeparture)

Constructs a Prediction object. For use on server side.

Parameters:

avlReport -

stopId -

gtfsStopSeq -

trip - Can be set to null for testing but usually will be a valid trip

predictionTime - The prediction to present to the user. Can be different from actualPredictionTime in that for wait stops might want to show user the scheduled time even if the actual prediction time, including the stop wait time, might be greater.

actualPredictionTime - The prediction time including all factors, including the stop wait time for wait stops presented to the user is different than the actual prediction time. Only used on server side when calculating predictions.

atEndOfTrip - True if prediction for last stop of trip, which means likely not useful to user

predictionAffectedByWaitStop -

isDelayed -

lateAndSubsequentTripSoMarkAsUncertain -

arrivalOrDeparture -

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getVehicleId

public java.lang.String getVehicleId()

getRouteId

public java.lang.String getRouteId()

getStopId

public java.lang.String getStopId()

getGtfsStopSeq

public int getGtfsStopSeq()

Returns:

the stop_sequence from the GTFS stop_times.txt file

getTripId

public java.lang.String getTripId()

getTripPatternId

public java.lang.String getTripPatternId()

getBlockId

public java.lang.String getBlockId()

getPredictionTime

public long getPredictionTime()

getActualPredictionTime

public long getActualPredictionTime()

isAtEndOfTrip

public boolean isAtEndOfTrip()

isSchedBasedPred

public boolean isSchedBasedPred()

isAffectedByWaitStop

public boolean isAffectedByWaitStop()

getAvlTime

public long getAvlTime()

getCreationTime

public long getCreationTime()

getTripStartEpochTime

public long getTripStartEpochTime()

getDriverId

public java.lang.String getDriverId()

Returns the driver ID if it is available. Otherwise returns null.

Returns:

getPassengerCount

public short getPassengerCount()

Returns the passenger count as obtained from the AVL feed. The value will not be valid for systems that do not have passenger counting sensors. Therefore should use isPassengerCountValid() to determine if the value is valid.

Returns:

Passenger count from the AVL feed

isPassengerCountValid

public boolean isPassengerCountValid()

Passenger counts only valid for systems where there actually are passenger counting sensors.

Returns:

True if getPassengerCount() returns a valid value

isDelayed

public boolean isDelayed()

isLateAndSubsequentTripSoMarkAsUncertain

public boolean isLateAndSubsequentTripSoMarkAsUncertain()

For when vehicle is quite late and prediction is for a subsequent trip.

Returns:

isArrival

public boolean isArrival()

getTrip

public Trip getTrip()

Returns the trip associated with the prediction. Only valid on server side since trip is not passed to client.

Returns:

getRouteShortName

public java.lang.String getRouteShortName()

Returns the short name for the route associated with the prediction. Only valid on server side since uses the trip member and the trip is not passed to client.

Returns: