org.transitime.db.structs

Class Location

java.lang.Object

org.transitime.db.structs.Location

All Implemented Interfaces:

java.io.Serializable

@Immutable
 @Embeddable
public class Location
extends java.lang.Object
implements java.io.Serializable

Defines a latitude longitude pair that together specify a location.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Location(double lat, double lon) Member Functions

Method Summary

Modifier and Type	Method and Description
double	distance(Location l2) Returns distance in meters between this location and the location l2 passed in.
double	distance(Vector v) Returns distance in meters between location and the closest match to the specified Vector.
boolean	equals(java.lang.Object obj) If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.
double	getLat()
double	getLon()
int	hashCode() If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.
double	matchDistanceAlongVector(Vector v) Returns length along vector where this location is closest to the vector.
java.lang.String	toString() Outputs only "[lat, lon]".

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Location

public Location(double lat,
                double lon)

Member Functions

Method Detail

hashCode

public int hashCode()

If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.

Overrides:

equals in class java.lang.Object

getLat

public double getLat()

getLon

public double getLon()

distance

public double distance(Location l2)

Returns distance in meters between this location and the location l2 passed in.

Parameters:

l2 -

Returns:

Distance in meters

distance

public double distance(Vector v)

Returns distance in meters between location and the closest match to the specified Vector.

Parameters:

v -

Returns:

matchDistanceAlongVector

public double matchDistanceAlongVector(Vector v)

Returns length along vector where this location is closest to the vector.

Parameters:

v -

Returns:

toString

public java.lang.String toString()

Outputs only "[lat, lon]". This is a bit different from all the other toString() methods but the nice thing is that then one can just cut & paste a location into a map in order to visualize it.

Overrides:

toString in class java.lang.Object