Vector

java.lang.Object
- org.transitime.db.structs.Vector

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

VectorWithHeading
```
public class Vector
extends java.lang.Object
implements java.io.Serializable
```
Simple vector that contains two locations.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Vector(Location l1, Location l2)
Member Functions

Constructors
Constructor and Description
`Vector(Location l1, Location l2)` Member Functions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`angle()` Returns the angle in radians of the vector from the equator.
`Vector`	`beginning(double beginningLength)` Returns the first part of the vector that is the length specified.
`double`	`distance(Location l)` Determines the distance between a location and this vector.
`Vector`	`end(double beginningLength)` Returns the last part of the vector, starting after the beginningLength
`Location`	`getL1()` Returns the first Location of the Vector
`Location`	`getL2()` Returns the second Location of the Vector
`double`	`heading()` Returns number of degrees clockwise from due North.
`double`	`length()` Returns the length of the Vector in meters.
`Location`	`locAlongVector(double length)` Returns the location that is the length specified along the vector.
`static void`	`main(java.lang.String[] args)`
`double`	`matchDistanceAlongVector(Location l)` Returns length along vector where this location is closest to the vector.
`Vector`	`middle(double length1, double length2)` Returns the middle of this vector that starts at length1 and ends at length2.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Vector
```
public Vector(Location l1,
              Location l2)
```
    Member Functions
- Method Detail
  - getL1
```
public Location getL1()
```
    Returns the first Location of the Vector
    
    Returns:
  - getL2
```
public Location getL2()
```
    Returns the second Location of the Vector
    
    Returns:
  - length
```
public double length()
```
    Returns the length of the Vector in meters.
    
    Returns:
    
    length of vector in meters
  - distance
```
public double distance(Location l)
```
    Determines the distance between a location and this vector. Looks for a line between the location that is orthogonal to the line representing the vector. If the intersection with the line would actually be before or after the vector then the distance from the location to the corresponding end point of the vector is returned. But if the intersection of the orthogonal line to the vector line is within the vector then the length of the orthogonal line is returned.
    
    Parameters:
    
    l - The location
    
    Returns:
    
    Distance from location parameter to the vector
  - matchDistanceAlongVector
```
public double matchDistanceAlongVector(Location l)
```
    Returns length along vector where this location is closest to the vector.
    
    Parameters:
    
    l -
    
    Returns:
    
    Distance along the vector that the location best matches
  - angle
```
public double angle()
```
    Returns the angle in radians of the vector from the equator. Note that this is very different from heading().
    
    Returns:
  - heading
```
public double heading()
```
    Returns number of degrees clockwise from due North. Note that this is very different from angle().
    
    Returns:
  - locAlongVector
```
public Location locAlongVector(double length)
```
    Returns the location that is the length specified along the vector.
    
    Parameters:
    
    length -
    
    Returns:
    
    Location along vector specified by length parameter
  - beginning
```
public Vector beginning(double beginningLength)
```
    Returns the first part of the vector that is the length specified.
    
    Parameters:
    
    beginningLength - The length of the beginning part of the vector to be returned
    
    Returns:
    
    The beginning part of the vector, having the length specified
  - end
```
public Vector end(double beginningLength)
```
    Returns the last part of the vector, starting after the beginningLength
    
    Parameters:
    
    beginningLength - The length after which the resulting vector is to be returned.
    
    Returns:
    
    The end part of the vector, starting after the length specified
  - middle
```
public Vector middle(double length1,
                     double length2)
```
    Returns the middle of this vector that starts at length1 and ends at length2. The resulting length should be length2-length1.
    
    Parameters:
    
    length1 -
    
    length2 -
    
    Returns:
  - main
```
public static void main(java.lang.String[] args)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Vector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vector

Method Detail

getL1

getL2

length

distance

matchDistanceAlongVector

angle

heading

locAlongVector

beginning

end

middle

main

toString