org.opentrafficsim.road.gtu.lane.perception.categories

Class AbstractDelayedPerceptionCategory

java.lang.Object

org.opentrafficsim.base.Type<org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory<G,P>>

org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory<LaneBasedGTU,LanePerception>

org.opentrafficsim.road.gtu.lane.perception.categories.LaneBasedAbstractPerceptionCategory

org.opentrafficsim.road.gtu.lane.perception.categories.AbstractDelayedPerceptionCategory

All Implemented Interfaces:

Serializable, org.opentrafficsim.core.gtu.perception.PerceptionCategory<LaneBasedGTU,LanePerception>, LaneBasedPerceptionCategory

Direct Known Subclasses:

AbstractDelayedNeighborsPerception

public abstract class AbstractDelayedPerceptionCategory
extends LaneBasedAbstractPerceptionCategory
implements LaneBasedPerceptionCategory

Utility superclass for perception categories with single delayed snapshots.

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 14 feb. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDelayedPerceptionCategory.DelayedInfoType<T> Superclass for delayed info.

Field Summary

Fields inherited from class org.opentrafficsim.road.gtu.lane.perception.categories.LaneBasedAbstractPerceptionCategory

MAX_RED_DECELERATION, MAX_YELLOW_DECELERATION

Constructor Summary

Constructors

Constructor and Description
AbstractDelayedPerceptionCategory(LanePerception perception)

Method Summary

Modifier and Type	Method and Description
void	changeLane(org.opentrafficsim.core.network.LateralDirectionality dir) Move data coupled to a lane to another lane to account for a lane change.
<T> org.opentrafficsim.base.TimeStampedObject<T>	getInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType) Returns the most recent info of the given type, that is older than the delay.
<T> org.opentrafficsim.base.TimeStampedObject<T>	getInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType, RelativeLane lane) Returns the most recent info of the given type, that is older than the delay.
<T> void	setInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType, RelativeLane lane, org.opentrafficsim.base.TimeStampedObject<T> info) Set info of given delayed info type, pertaining to a lane.
<T> void	setInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType, org.opentrafficsim.base.TimeStampedObject<T> info) Set info of given delayed info type, not pertaining to any lane.

Methods inherited from class org.opentrafficsim.core.gtu.perception.AbstractPerceptionCategory

getGtu, getObjectOrNull, getPerception, getTimestamp

Methods inherited from class org.opentrafficsim.base.Type

isType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.core.gtu.perception.PerceptionCategory

updateAll

Constructor Detail

AbstractDelayedPerceptionCategory

public AbstractDelayedPerceptionCategory(LanePerception perception)

Parameters:

perception - perception

Method Detail

setInfo

public final <T> void setInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType,
                              org.opentrafficsim.base.TimeStampedObject<T> info)

Set info of given delayed info type, not pertaining to any lane.

Type Parameters:

T - data type of delayed info

Parameters:

delayedInfoType - info type

info - info

setInfo

public final <T> void setInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType,
                              RelativeLane lane,
                              org.opentrafficsim.base.TimeStampedObject<T> info)

Set info of given delayed info type, pertaining to a lane.

Type Parameters:

T - data type of delayed info

Parameters:

delayedInfoType - info type

lane - lane, may be null

info - info

getInfo

public final <T> org.opentrafficsim.base.TimeStampedObject<T> getInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType)
                                                               throws org.opentrafficsim.core.gtu.perception.PerceptionException

Returns the most recent info of the given type, that is older than the delay. If all data is more recent than the delay, the oldest data is returned. If no data is present, an exception is thrown.

Type Parameters:

T - data type of the info type

Parameters:

delayedInfoType - info type

Returns:

info of the given type

Throws:

org.opentrafficsim.core.gtu.perception.PerceptionException - if info was not perceived

getInfo

public final <T> org.opentrafficsim.base.TimeStampedObject<T> getInfo(AbstractDelayedPerceptionCategory.DelayedInfoType<T> delayedInfoType,
                                                                      RelativeLane lane)
                                                               throws org.opentrafficsim.core.gtu.perception.PerceptionException

Returns the most recent info of the given type, that is older than the delay. If all data is more recent than the delay, the oldest data is returned. If no data is present, an exception is thrown.

Type Parameters:

T - data type of the info type

Parameters:

delayedInfoType - info type

lane - lane the data pertains to, may be null

Returns:

info of the given type

Throws:

org.opentrafficsim.core.gtu.perception.PerceptionException - if info was not perceived

changeLane

public final void changeLane(org.opentrafficsim.core.network.LateralDirectionality dir)

Move data coupled to a lane to another lane to account for a lane change. The tactical planner needs to call this exactly when it flips logic concerning the origin and target lane.

Parameters:

dir - direction of lane change