org.opentrafficsim.road.gtu.generator

Interface LaneBasedGTUGenerator.RoomChecker

Enclosing class:

LaneBasedGTUGenerator

public static interface LaneBasedGTUGenerator.RoomChecker

Interface for class that checks that there is sufficient room for a proposed new GTU and returns the maximum safe speed for the proposed new GTU.

Method Summary

Modifier and Type	Method and Description
org.djunits.value.vdouble.scalar.Speed	canPlace(org.djunits.value.vdouble.scalar.Speed leaderSpeed, org.djunits.value.vdouble.scalar.Length headway, LaneBasedGTUCharacteristics laneBasedGTUCharacteristics) Return the maximum safe speed for a new GTU with the specified characteristics.

Method Detail

canPlace

org.djunits.value.vdouble.scalar.Speed canPlace(org.djunits.value.vdouble.scalar.Speed leaderSpeed,
                                                org.djunits.value.vdouble.scalar.Length headway,
                                                LaneBasedGTUCharacteristics laneBasedGTUCharacteristics)
                                         throws org.opentrafficsim.core.network.NetworkException

Return the maximum safe speed for a new GTU with the specified characteristics. Return null if there is no safe speed. This method will never be called if the newly proposed GTU overlaps with the leader. Nor will this method be called if there is no leader.

Parameters:

leaderSpeed - Speed; speed of the nearest leader

headway - Length; net distance to the nearest leader (always > 0)

laneBasedGTUCharacteristics - LaneBasedGTUCharacteristics; characteristics of the proposed new GTU

Returns:

Speed; maximum safe speed, or null if a GTU with the specified characteristics cannot be placed at the current time

Throws:

org.opentrafficsim.core.network.NetworkException - this method may throw a NetworkException if it encounters an error in the network structure