IncentiveGetInLane (Open Traffic Sim road classes 1.04.04 API)

java.lang.Object
- org.opentrafficsim.road.gtu.lane.tactical.lmrs.IncentiveGetInLane

All Implemented Interfaces:

Incentive, MandatoryIncentive
```
public class IncentiveGetInLane
extends Object
implements MandatoryIncentive
```
Incentive that lets drivers queue in an adjacent lane as soon as the speed is low in the adjacent lane, and stopping in the current lane might block traffic towards other directions.
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.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 28 mrt. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary

Fields
Modifier and Type	Field	Description
`protected static ParameterTypeDouble`	`SOCIO`	Hierarchy parameter.
`protected static ParameterTypeSpeed`	`VCONG`	Congestion speed threshold parameter type.

Constructor Summary

Constructors
Constructor Description

IncentiveGetInLane()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Desire`	`determineDesire(Parameters parameters, LanePerception perception, CarFollowingModel carFollowingModel, Desire mandatoryDesire)`	Determines level of lane change desire for a lane change incentive.
`String`	`toString()`

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

- Field Detail
  - VCONG
```
protected static final ParameterTypeSpeed VCONG
```
    Congestion speed threshold parameter type.
  - SOCIO
```
protected static final ParameterTypeDouble SOCIO
```
    Hierarchy parameter.
- Constructor Detail
  - IncentiveGetInLane
```
public IncentiveGetInLane()
```
- Method Detail
  - determineDesire
```
public Desire determineDesire(Parameters parameters,
                              LanePerception perception,
                              CarFollowingModel carFollowingModel,
                              Desire mandatoryDesire)
                       throws ParameterException,
                              OperationalPlanException
```
    Determines level of lane change desire for a lane change incentive.
    
    Specified by:
    
    determineDesire in interface MandatoryIncentive
    
    Parameters:
    
    parameters - Parameters; parameters
    
    perception - LanePerception; perception
    
    carFollowingModel - CarFollowingModel; car-following model
    
    mandatoryDesire - Desire; level of mandatory desire at current time
    
    Returns:
    
    level of lane change desire for this incentive
    
    Throws:
    
    ParameterException - if a parameter is not given or out of bounds
    
    OperationalPlanException - in case of a perception exception
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object