org.transitime.db.structs

Class TravelTimesForStopPath

java.lang.Object

org.transitime.db.structs.TravelTimesForStopPath

All Implemented Interfaces:

java.io.Serializable

@Entity
public class TravelTimesForStopPath
extends java.lang.Object
implements java.io.Serializable

Contains the expected time it takes to travel along the specified path, which is for one stop to another. There can be a different list of TravelTimesForStopPath for each trip. The idea is to share travel times when possible, when they are relatively the same for a trip pattern. But if a trip needs separate travel times then it can have it.

Author:

SkiBu Smith

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TravelTimesForStopPath.HowSet This enumeration is for keeping track of how the travel times were determined.

Constructor Summary

Constructors

Constructor and Description
TravelTimesForStopPath(int configRev, int travelTimesRev, java.lang.String stopPathId, double travelTimeSegmentDistance, java.util.List<java.lang.Integer> travelTimesMsec, int stopTimeMsec, int daysOfWeekOverride, TravelTimesForStopPath.HowSet howSet, Trip trip) Constructs a new TravelTimesForStopPath object.

Method Summary

Modifier and Type	Method and Description
TravelTimesForStopPath	clone(int newTravelTimesRev) Creates a new object.
boolean	equals(java.lang.Object obj) Defined so can use as key in map
int	getConfigRev() Getter Methods
int	getDaysOfWeekOverride()
TravelTimesForStopPath.HowSet	getHowSet()
int	getNumberTravelTimeSegments()
java.lang.String	getStopPathId()
int	getStopPathTravelTimeMsec() Returns total travel time for the stop path.
int	getStopTimeMsec() How long the vehicle is expected to dwell at stop.
static java.util.List<TravelTimesForStopPath>	getTravelTimes(org.hibernate.SessionFactory sessionFactory, int configRev) Reads in all the travel times for the specified rev
double	getTravelTimeSegmentLength() The travel time segment distance specifies how the stop path is divided up with respect to travel times.
int	getTravelTimeSegmentMsec(int segmentIndex) Returns the travel time for the specified travel time segment in msec
java.util.List<java.lang.Integer>	getTravelTimesMsec()
int	getTravelTimesRev()
int	hashCode() Defined so can use as key in map
java.lang.String	toString()
java.lang.String	toStringEmphasizeTravelTimes() For when the travelTimesMsec are most important element.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TravelTimesForStopPath

public TravelTimesForStopPath(int configRev,
                              int travelTimesRev,
                              java.lang.String stopPathId,
                              double travelTimeSegmentDistance,
                              java.util.List<java.lang.Integer> travelTimesMsec,
                              int stopTimeMsec,
                              int daysOfWeekOverride,
                              TravelTimesForStopPath.HowSet howSet,
                              Trip trip)
                       throws java.lang.ArrayIndexOutOfBoundsException

Constructs a new TravelTimesForStopPath object.

Parameters:

configRev -

travelTimesRev -

stopPathId -

travelTimeSegmentDistance -

travelTimesMsec - The travel times for the travel time segments.

stopTimeMsec -

howSet -

daysOfWeekOverride -

trip - for logging useful error message. OK if null.

Throws:

java.lang.ArrayIndexOutOfBoundsException - Thrown if not enough memory allocated for column travelTimesMsec for serializing the object.

Method Detail

clone

public TravelTimesForStopPath clone(int newTravelTimesRev)

Creates a new object. Useful for when need to copy a schedule based travel time. By having a copy can erase the original one when done with the travel time rev, without deleting this new one.

Parameters:

newTravelTimesRev - The new travel times rev to use for the clone

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringEmphasizeTravelTimes

public java.lang.String toStringEmphasizeTravelTimes()

For when the travelTimesMsec are most important element. Lists the travelTimesMsec first.

Returns:

getConfigRev

public int getConfigRev()

Getter Methods

getTravelTimesRev

public int getTravelTimesRev()

getStopPathId

public java.lang.String getStopPathId()

Returns:

the stopPathId

getTravelTimeSegmentLength

public double getTravelTimeSegmentLength()

The travel time segment distance specifies how the stop path is divided up with respect to travel times. The travel times for a stop path are uniformly divided. This means that each travel time segment for a stop path has the same length.

Returns:

the travelTimeSegmentLength

getTravelTimesMsec

public java.util.List<java.lang.Integer> getTravelTimesMsec()

Returns:

the travelTimeMsec

getNumberTravelTimeSegments

public int getNumberTravelTimeSegments()

Returns:

How many travel time segments there are for the stop path

getStopPathTravelTimeMsec

public int getStopPathTravelTimeMsec()

Returns total travel time for the stop path. Does not include the stop time.

Returns:

total travel time for the stop path in msec

getTravelTimeSegmentMsec

public int getTravelTimeSegmentMsec(int segmentIndex)

Returns the travel time for the specified travel time segment in msec

Parameters:

segmentIndex -

Returns:

travel time for the specified travel time segment in msec

getStopTimeMsec

public int getStopTimeMsec()

How long the vehicle is expected to dwell at stop. Doesn't include layover times and such. Based on historic AVL data.

Returns:

the stopTimeMsec

getDaysOfWeekOverride

public int getDaysOfWeekOverride()

Returns:

the daysOfWeekOverride

getHowSet

public TravelTimesForStopPath.HowSet getHowSet()

Returns:

the howSet

getTravelTimes

public static java.util.List<TravelTimesForStopPath> getTravelTimes(org.hibernate.SessionFactory sessionFactory,
                                                                    int configRev)

Reads in all the travel times for the specified rev

Parameters:

sessionFactory -

configRev -

Returns:

hashCode

public int hashCode()

Defined so can use as key in map

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Defined so can use as key in map

Overrides:

equals in class java.lang.Object