GeneratorPositions.RoadPosition.BySpeed (OpenTrafficSim road classes 1.6.0 API)

java.lang.Object
- org.opentrafficsim.road.gtu.generator.GeneratorPositions.RoadPosition.BySpeed

All Implemented Interfaces:

GeneratorPositions.RoadPosition

Enclosing interface:

GeneratorPositions.RoadPosition
```
public static class GeneratorPositions.RoadPosition.BySpeed
extends Object
implements GeneratorPositions.RoadPosition
```
Road position based on desired speed.
Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 15 jan. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.generator.GeneratorPositions.RoadPosition
  GeneratorPositions.RoadPosition.BySpeed, GeneratorPositions.RoadPosition.ByValue

Constructor Summary

Constructors
Constructor Description

BySpeed(Speed leftSpeed, Speed rightSpeed)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`double`	`getValue(Speed desiredSpeed)`	Returns the road position (0.0 = right, 1.0 = left).
`int`	`hashCode()`

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

- Constructor Detail
  - BySpeed
```
public BySpeed(Speed leftSpeed,
               Speed rightSpeed)
```
    Constructor.
    
    Parameters:
    
    leftSpeed - Speed; desired speed at left side of the road
    
    rightSpeed - Speed; desired speed at right side of the road
- Method Detail
  - getValue
```
public double getValue(Speed desiredSpeed)
```
    Returns the road position (0.0 = right, 1.0 = left).
    
    Specified by:
    
    getValue in interface GeneratorPositions.RoadPosition
    
    Parameters:
    
    desiredSpeed - Speed; desired speed at the generator
    
    Returns:
    
    road position (0.0 = right, 1.0 = left)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object