org.opentrafficsim.road.gtu.strategical

Interface LaneBasedStrategicalPlannerFactory<T extends LaneBasedStrategicalPlanner>

Type Parameters:

T - class of the strategical planner generated

All Known Implementing Classes:

AbstractLaneBasedStrategicalPlannerFactory, LaneBasedStrategicalRoutePlannerFactory

public interface LaneBasedStrategicalPlannerFactory<T extends LaneBasedStrategicalPlanner>

A factory class is used to generate strategical planners as the strategical planner is state-full.

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 Jul 29, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
T	create(LaneBasedGTU gtu, org.opentrafficsim.core.network.route.Route route, org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination) Creates a new strategical planner for the given GTU.
default org.djunits.value.vdouble.scalar.Length	peekDesiredHeadway(org.opentrafficsim.core.gtu.GTUType gtuType, org.djunits.value.vdouble.scalar.Speed speed) Peek to see the desired headway of the next GTU to be generated at the given speed.
default org.djunits.value.vdouble.scalar.Speed	peekDesiredSpeed(org.opentrafficsim.core.gtu.GTUType gtuType, org.djunits.value.vdouble.scalar.Speed speedLimit, org.djunits.value.vdouble.scalar.Speed maxGtuSpeed) Peek to see the desired speed of the next GTU to be generated at the given location.

Method Detail

create

T create(LaneBasedGTU gtu,
         org.opentrafficsim.core.network.route.Route route,
         org.opentrafficsim.core.network.Node origin,
         org.opentrafficsim.core.network.Node destination)
  throws org.opentrafficsim.core.gtu.GTUException

Creates a new strategical planner for the given GTU. This method should also set the parameters at the GTU.

Parameters:

gtu - GTU

route - route, may be null

origin - origin, may be null

destination - destination, may be null

Returns:

strategical planner for the given GTU

Throws:

org.opentrafficsim.core.gtu.GTUException - if the gtu is not suitable in any way for the creation of the strategical planner

peekDesiredSpeed

default org.djunits.value.vdouble.scalar.Speed peekDesiredSpeed(org.opentrafficsim.core.gtu.GTUType gtuType,
                                                                org.djunits.value.vdouble.scalar.Speed speedLimit,
                                                                org.djunits.value.vdouble.scalar.Speed maxGtuSpeed)
                                                         throws org.opentrafficsim.core.gtu.GTUException

Peek to see the desired speed of the next GTU to be generated at the given location. The default implementation returns null, at which point the GTU generator will use some other speed.

Parameters:

gtuType - GTUType; GTU type

speedLimit - Speed; speed limit

maxGtuSpeed - Speed; maximum GTU speed

Returns:

desired speed of the next GTU to be generated at the given location, may be null at which point the GTU generator will use some other speed

Throws:

org.opentrafficsim.core.gtu.GTUException - on parameter exception or network exception

peekDesiredHeadway

default org.djunits.value.vdouble.scalar.Length peekDesiredHeadway(org.opentrafficsim.core.gtu.GTUType gtuType,
                                                                   org.djunits.value.vdouble.scalar.Speed speed)
                                                            throws org.opentrafficsim.core.gtu.GTUException

Peek to see the desired headway of the next GTU to be generated at the given speed. The default implementation returns null, at which point the GTU generator will only generate GTU's at fixed locations.

Parameters:

gtuType - GTUType; GTU type

speed - Speed; speed the GTU might be generated at

Returns:

Length; desired headway of the next GTU to be generated at the given speed, may be null at which point the GTU generator only generate GTU's at fixed locations

Throws:

org.opentrafficsim.core.gtu.GTUException - on parameter exception or network exception