org.transitime.core

Class TemporalDifference

java.lang.Object

org.transitime.core.TemporalDifference

All Implemented Interfaces:

java.io.Serializable

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

For keeping track of how far off a vehicle is from the expected time. For schedule adherence and for determining temporal matches. Positive means ahead of and traveling faster than expected.

Class made serializable so that schedule adherence data can be made available through RMI calls.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TemporalDifference(int temporalDifferenceMsec)
TemporalDifference(long temporalDifferenceMsec) Often working with longs for time so it is convenient to have a constructor that will accept a long as the temporal difference.

Method Summary

Modifier and Type	Method and Description
void	addTime(int latenessMsec) Adds the latenessMsec to this.
boolean	betterThan(TemporalDifference other) Returns true if the temporal difference for this object is better than that for the TemporalDifference parameter other.
boolean	betterThanOrEqualTo(TemporalDifference other) Returns if the temporal difference for this object is better than or equal to that for the TemporalDifference parameter other.
int	early() If early then returns positive value indicating how many msec early.
int	getTemporalDifference() Returns the temporalDifferenceMsec in msec.
boolean	isEarlierThan(int allowableEarlySeconds) Returns true if vehicle is earlier than allowableEarlySeconds
boolean	isLaterThan(int allowableLateSeconds) Returns true if vehicle is later than allowableLateSeconds
boolean	isWithinBounds() Returns true if the temporal difference is within the bounds specified by CoreConfig.getAllowableEarlySeconds() and CoreConfig.getAllowableLateSeconds().
boolean	isWithinBounds(int allowableEarlySeconds, int allowableLateSeconds) Returns whether the temporal difference is within the specified bounds.
boolean	isWithinBoundsForInitialMatching() Returns true if the temporal difference is within the bounds specified by CoreConfig.getAllowableEarlySecondsForInitialMatching() and CoreConfig.getAllowableLateSecondsForInitialMatching().
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalDifference

public TemporalDifference(int temporalDifferenceMsec)

Parameters:

temporalDifferenceMsec - Positive means vehicle is ahead of where expected, negative means behind.

TemporalDifference

public TemporalDifference(long temporalDifferenceMsec)

Often working with longs for time so it is convenient to have a constructor that will accept a long as the temporal difference.

Parameters:

temporalDifferenceMsec - Positive means vehicle is ahead of where expected, negative means behind.

Method Detail

addTime

public void addTime(int latenessMsec)

Adds the latenessMsec to this. If the vehicle is early then the latenessMsec is simply subtracted. But if vehicle is late then latenessMsec is added, but only after dividing it by the early to late ratio since early vehicles are considered worse than late vehicles.

Parameters:

latenessMsec - How much lateness to add.

isWithinBounds

public boolean isWithinBounds()

Returns true if the temporal difference is within the bounds specified by CoreConfig.getAllowableEarlySeconds() and CoreConfig.getAllowableLateSeconds().

Returns:

true if within bounds

isWithinBoundsForInitialMatching

public boolean isWithinBoundsForInitialMatching()

Returns true if the temporal difference is within the bounds specified by CoreConfig.getAllowableEarlySecondsForInitialMatching() and CoreConfig.getAllowableLateSecondsForInitialMatching(). For use when initially matching a vehicle. Need to be more restrictive than for other matching since the initial matching is more difficult. Need to only match if it is a reasonable match since vehicles do really peculiar things.

Returns:

true if within bounds

isWithinBounds

public boolean isWithinBounds(int allowableEarlySeconds,
                              int allowableLateSeconds)

Returns whether the temporal difference is within the specified bounds.

Parameters:

allowableEarlySeconds -

allowableLateSeconds -

Returns:

isEarlierThan

public boolean isEarlierThan(int allowableEarlySeconds)

Returns true if vehicle is earlier than allowableEarlySeconds

Parameters:

allowableEarlySeconds -

Returns:

isLaterThan

public boolean isLaterThan(int allowableLateSeconds)

Returns true if vehicle is later than allowableLateSeconds

Parameters:

allowableLateSeconds -

Returns:

early

public int early()

If early then returns positive value indicating how many msec early. If late then returns negative value indicating how many msec late.

Returns:

betterThan

public boolean betterThan(TemporalDifference other)

Returns true if the temporal difference for this object is better than that for the TemporalDifference parameter other. If other param is null then will return true.

Parameters:

other - TemporalDifference to be compared to. Can be null.

Returns:

betterThanOrEqualTo

public boolean betterThanOrEqualTo(TemporalDifference other)

Returns if the temporal difference for this object is better than or equal to that for the TemporalDifference parameter other.

Parameters:

other - TemporalDifference to be compared to

Returns:

getTemporalDifference

public int getTemporalDifference()

Returns the temporalDifferenceMsec in msec. Positive means vehicle is early and negative means that vehicle is late.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object