KpiLaneDirection (OpenTrafficSim KPI Module 1.04.02 API)

java.lang.Object
- org.opentrafficsim.kpi.sampling.KpiLaneDirection

All Implemented Interfaces:

java.io.Serializable
```
public class KpiLaneDirection
extends java.lang.Object
implements java.io.Serializable
```
Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Mar 30, 2016

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

KpiLaneDirection(LaneDataInterface lane, KpiGtuDirectionality direction)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`KpiGtuDirectionality`	`getKpiDirection()`
`LaneDataInterface`	`getLaneData()`
`Length`	`getPositionInDirection(Length position)`	Returns the position with increasing value in the direction of travel, i.e.
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KpiLaneDirection
```
public KpiLaneDirection(LaneDataInterface lane,
                        KpiGtuDirectionality direction)
```
    Parameters:
    
    lane - LaneDataInterface; the lane
    
    direction - KpiGtuDirectionality; the direction to drive on this lane
- Method Detail
  - getLaneData
```
public final LaneDataInterface getLaneData()
```
    Returns:
    
    the lane
  - getKpiDirection
```
public final KpiGtuDirectionality getKpiDirection()
```
    Returns:
    
    the direction to drive on this lane
  - getPositionInDirection
```
public final Length getPositionInDirection(Length position)
```
    Returns the position with increasing value in the direction of travel, i.e. the node to the back of the vehicle is at x = 0 while the node in front of the vehicle is at x = lane.getLength(), irrespective of the design line direction.
    
    Parameters:
    
    position - Length; the position on the lane irrespective of the direction
    
    Returns:
    
    position with increasing value in the direction of travel
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object