org.transitime.db.structs

Class VectorWithHeading

java.lang.Object

org.transitime.db.structs.Vector

org.transitime.db.structs.VectorWithHeading

All Implemented Interfaces:

java.io.Serializable

public class VectorWithHeading
extends Vector

Inherits from Vector but automatically calculates the heading. Useful for if heading is frequently used.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VectorWithHeading(Location l1, Location l2) Construct a vector and determine its heading.

Method Summary

Modifier and Type	Method and Description
float	getHeading()
boolean	headingOK(float vehicleHeading, float allowableDelta) Returns true if heading is within allowableDelta of segment.
java.lang.String	toString()

Methods inherited from class org.transitime.db.structs.Vector

angle, beginning, distance, end, getL1, getL2, heading, length, locAlongVector, main, matchDistanceAlongVector, middle

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorWithHeading

public VectorWithHeading(Location l1,
                         Location l2)

Construct a vector and determine its heading. Heading will be between -180 and 180 degrees.

Parameters:

l1 -

l2 -

Method Detail

getHeading

public float getHeading()

Returns:

Heading in degrees clockwise from due North. Note that this is not the same as the "angle" which is degrees clockwise from the equator. The value is calculated in the constructor so that this method is efficient if the heading is retrieved multiple times for a vector.

headingOK

public boolean headingOK(float vehicleHeading,
                         float allowableDelta)

Returns true if heading is within allowableDelta of segment.

Parameters:

vehicleHeading - Heading of vehicle. If Float.NaN then method will return true

allowableDelta -

Returns:

Whether heading is within allowableDelta of segment

toString

public java.lang.String toString()

Overrides:

toString in class Vector