Estimation.FactorEstimation (OpenTrafficSim road classes 1.6.0 API)

java.lang.Object
- org.opentrafficsim.road.gtu.lane.perception.categories.neighbors.Estimation.FactorEstimation

All Implemented Interfaces:

Estimation

Enclosing interface:

Estimation
```
public abstract static class Estimation.FactorEstimation
extends Object
implements Estimation
```
Estimation based on a factor.
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 31 jan. 2019

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.lane.perception.categories.neighbors.Estimation
  Estimation.FactorEstimation

Field Summary
- Fields inherited from interface org.opentrafficsim.road.gtu.lane.perception.categories.neighbors.Estimation
  NONE, OVERESTIMATION, UNDERESTIMATION

Constructor Summary

Constructors
Constructor Description

FactorEstimation()
Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`NeighborTriplet`	`estimate(LaneBasedGTU perceivingGtu, LaneBasedGTU perceivedGtu, Length distance, boolean downstream, Time when)`	Estimate headway, speed and acceleration.
`(package private) abstract boolean`	`overEstimation()`	Returns whether this is over-estimation.

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

Methods inherited from interface org.opentrafficsim.road.gtu.lane.perception.categories.neighbors.Estimation
getDelayedHeadway, getDelayedSpeedDifference, getEgoSpeed

- Constructor Detail
  - FactorEstimation
```
FactorEstimation()
```
    Constructor.
- Method Detail
  - estimate
```
public NeighborTriplet estimate(LaneBasedGTU perceivingGtu,
                                LaneBasedGTU perceivedGtu,
                                Length distance,
                                boolean downstream,
                                Time when)
                         throws org.opentrafficsim.base.parameters.ParameterException
```
    Estimate headway, speed and acceleration.
    
    Specified by:
    
    estimate in interface Estimation
    
    Parameters:
    
    perceivingGtu - LaneBasedGTU; perceiving GTU
    
    perceivedGtu - LaneBasedGTU; perceived GTU
    
    distance - Length; actual headway at 'now' (i.e. not at 'when' if there is a reaction time)
    
    downstream - boolean; downstream (or upstream) neighbor
    
    when - Time; moment of perception, reaction time included
    
    Returns:
    
    NeighborTriplet; perceived headway, speed and acceleration
    
    Throws:
    
    org.opentrafficsim.base.parameters.ParameterException - on invalid parameter value or if parameter is not available
  - overEstimation
```
abstract boolean overEstimation()
```
    Returns whether this is over-estimation.
    
    Returns:
    
    boolean; whether this is over-estimation