org.opentrafficsim.road.gtu.lane.tactical.util.lmrs

Class LmrsData

java.lang.Object

org.opentrafficsim.road.gtu.lane.tactical.util.lmrs.LmrsData

All Implemented Interfaces:

DesireBased, Synchronizable

public final class LmrsData
extends Object
implements DesireBased, Synchronizable

Keeps data for LMRS for a specific GTU.

Copyright (c) 2013-2018 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 8 nov. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.animation.Synchronizable

Synchronizable.State

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Map<Class<? extends Incentive>,Desire>	desireMap Latest desire value for visualization.
(package private) Synchronizable.State	synchronizationState Synchronization state.

Constructor Summary

Constructors

Constructor and Description
LmrsData(Synchronization synchronization, Cooperation cooperation, GapAcceptance gapAcceptance, Tailgating tailGating)

Method Summary

Modifier and Type	Method and Description
(package private) void	finalizeStep() Remembers the leaders of the current time step (those forwarded to isNewLeader()) for the next time step.
(package private) Cooperation	getCooperation() Returns the cooperation.
(package private) GapAcceptance	getGapAcceptance() Return the gap-acceptance.
Desire	getLatestDesire(Class<? extends Incentive> incentiveClass) Returns the latest desire from the specified incentive.
(package private) Synchronization	getSynchronization() Returns the synchronization.
Synchronizable.State	getSynchronizationState() Returns the synchronization state.
(package private) HeadwayGTU	getSyncVehicle(PerceptionCollectable<HeadwayGTU,LaneBasedGTU> adjLeaders) Returns the gtu from the set that is the current sync vehicle, or null of there is no sync vehicle or it is not in the set.
(package private) Tailgating	getTailGating() Return the tail gating.
(package private) boolean	isNewLeader(HeadwayGTU gtu) Checks if the given leader is a new leader.
(package private) boolean	isSyncVehicle(HeadwayGTU gtu) Returns whether the provided gtu is the gtu that is synchronized to.
(package private) void	setSyncVehicle(HeadwayGTU gtu) Remembers the gtu that is synchronized to.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

desireMap

final Map<Class<? extends Incentive>,Desire> desireMap

Latest desire value for visualization.

synchronizationState

Synchronizable.State synchronizationState

Synchronization state.

Constructor Detail

LmrsData

public LmrsData(Synchronization synchronization,
                Cooperation cooperation,
                GapAcceptance gapAcceptance,
                Tailgating tailGating)

Parameters:

synchronization - synchronization

cooperation - cooperation

gapAcceptance - gap-acceptance

tailGating - tail gating

Method Detail

isNewLeader

boolean isNewLeader(HeadwayGTU gtu)

Checks if the given leader is a new leader.

Parameters:

gtu - gtu to check

Returns:

whether the gtu is a new leader

finalizeStep

void finalizeStep()

Remembers the leaders of the current time step (those forwarded to isNewLeader()) for the next time step.

setSyncVehicle

void setSyncVehicle(HeadwayGTU gtu)

Remembers the gtu that is synchronized to.

Parameters:

gtu - gtu that is synchronized to

isSyncVehicle

boolean isSyncVehicle(HeadwayGTU gtu)

Returns whether the provided gtu is the gtu that is synchronized to.

Parameters:

gtu - gtu to inquiry

Returns:

whether the provided gtu is the gtu that is synchronized to

getSyncVehicle

HeadwayGTU getSyncVehicle(PerceptionCollectable<HeadwayGTU,LaneBasedGTU> adjLeaders)

Returns the gtu from the set that is the current sync vehicle, or null of there is no sync vehicle or it is not in the set.

Parameters:

adjLeaders - leaders in adjacent lane

Returns:

gtu from the set that is the current sync vehicle

getSynchronization

Synchronization getSynchronization()

Returns the synchronization.

Returns:

synchronization

getCooperation

Cooperation getCooperation()

Returns the cooperation.

Returns:

cooperation

getGapAcceptance

GapAcceptance getGapAcceptance()

Return the gap-acceptance.

Returns:

gap-acceptance

getTailGating

Tailgating getTailGating()

Return the tail gating.

Returns:

gap-acceptance

getLatestDesire

public Desire getLatestDesire(Class<? extends Incentive> incentiveClass)

Returns the latest desire from the specified incentive.

Specified by:

getLatestDesire in interface DesireBased

Parameters:

incentiveClass - Class; incentive class

Returns:

latest desire from the specified incentive

getSynchronizationState

public Synchronizable.State getSynchronizationState()

Returns the synchronization state.

Specified by:

getSynchronizationState in interface Synchronizable

Returns:

State; synchronization state

toString

public String toString()

Overrides:

toString in class Object