SocioDesiredSpeed (Open Traffic Sim road classes 1.04.04 API)

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

All Implemented Interfaces:

DesiredSpeedModel, Initialisable
```
public class SocioDesiredSpeed
extends Object
implements DesiredSpeedModel, Initialisable
```
Wrapper of a base-desired speed model. The speed may be increased due to social pressure from the follower.
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 7 mrt. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary

Fields
Modifier and Type	Field	Description
`protected static ParameterTypeDouble`	`RHO`	Social pressure applied to the leader.
`protected static ParameterTypeDouble`	`SOCIO`	Socio-speed sensitivity parameter.
`protected static ParameterTypeSpeed`	`VGAIN`	Vgain parameter; ego-speed sensitivity.

Constructor Summary

Constructors
Constructor Description

SocioDesiredSpeed(DesiredSpeedModel baseModel)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Speed`	`desiredSpeed(Parameters parameters, SpeedLimitInfo speedInfo)`	Determines the desired speed.
`void`	`init(LaneBasedGTU laneBasedGtu)`	Initialize car-following model.

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

- Field Detail
  - RHO
```
protected static final ParameterTypeDouble RHO
```
    Social pressure applied to the leader.
  - SOCIO
```
protected static final ParameterTypeDouble SOCIO
```
    Socio-speed sensitivity parameter.
  - VGAIN
```
protected static final ParameterTypeSpeed VGAIN
```
    Vgain parameter; ego-speed sensitivity.
- Constructor Detail
  - SocioDesiredSpeed
```
public SocioDesiredSpeed(DesiredSpeedModel baseModel)
```
    Constructor.
    
    Parameters:
    
    baseModel - DesiredSpeedModel; base model for desired speed
- Method Detail
  - desiredSpeed
```
public Speed desiredSpeed(Parameters parameters,
                          SpeedLimitInfo speedInfo)
                   throws ParameterException
```
    Determines the desired speed.
    
    Specified by:
    
    desiredSpeed in interface DesiredSpeedModel
    
    Parameters:
    
    parameters - Parameters; parameters
    
    speedInfo - SpeedLimitInfo; info regarding the desired speed for car-following
    
    Returns:
    
    desired speed
    
    Throws:
    
    ParameterException - if parameter exception occurs
  - init
```
public void init(LaneBasedGTU laneBasedGtu)
```
    Initialize car-following model.
    
    Specified by:
    
    init in interface Initialisable
    
    Parameters:
    
    laneBasedGtu - LaneBasedGTU; gtu