Package org.opentrafficsim.road.gtu.strategical

Class LaneBasedStrategicalRoutePlannerFactory

java.lang.Object

org.opentrafficsim.road.gtu.strategical.LaneBasedStrategicalRoutePlannerFactory

All Implemented Interfaces:

LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalRoutePlanner>

public class LaneBasedStrategicalRoutePlannerFactory
extends Object
implements LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalRoutePlanner>

Factory for creating LaneBasedStrategicalRoutePlanner using any LaneBasedTacticalPlannerFactory.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor	Description
LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory)	Constructor with factory for tactical planners.
LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory, ParameterFactory parametersFactory)	Constructor with factory for tactical planners.
LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory, ParameterFactory parametersFactory, RouteGenerator routeGenerator)	Constructor with factory for tactical planners.

Method Summary

Modifier and Type	Method	Description
final LaneBasedStrategicalRoutePlanner	create(LaneBasedGtu gtu, Route route, Node origin, Node destination)	Creates a new strategical planner for the given GTU.
protected final Parameters	nextParameters(GtuType gtuType)	Returns the parameters for the next GTU.
Optional<Length>	peekDesiredHeadway(GtuType gtuType, Speed speed)	Peek to see the desired headway of the next GTU to be generated at the given speed.
Optional<Speed>	peekDesiredSpeed(GtuType gtuType, Speed speedLimit, Speed maxGtuSpeed)	Peek to see the desired speed of the next GTU to be generated at the given location.
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

LaneBasedStrategicalRoutePlannerFactory

public LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory)

Constructor with factory for tactical planners.

Parameters:

tacticalPlannerFactory - factory for tactical planners

LaneBasedStrategicalRoutePlannerFactory

public LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory,
 ParameterFactory parametersFactory)

Constructor with factory for tactical planners.

Parameters:

tacticalPlannerFactory - factory for tactical planners

parametersFactory - factory for parameters

LaneBasedStrategicalRoutePlannerFactory

public LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory,
 ParameterFactory parametersFactory,
 RouteGenerator routeGenerator)

Constructor with factory for tactical planners.

Parameters:

tacticalPlannerFactory - factory for tactical planners

parametersFactory - factory for parameters

routeGenerator - route supplier

Method Details

peekDesiredSpeed

public Optional<Speed> peekDesiredSpeed(GtuType gtuType,
 Speed speedLimit,
 Speed maxGtuSpeed)
                                 throws GtuException

Description copied from interface: LaneBasedStrategicalPlannerFactory

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.

Specified by:

peekDesiredSpeed in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalRoutePlanner>

Parameters:

gtuType - GTU type

speedLimit - speed limit

maxGtuSpeed - maximum GTU speed

Returns:

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

Throws:

GtuException - on parameter exception or network exception

peekDesiredHeadway

public Optional<Length> peekDesiredHeadway(GtuType gtuType,
 Speed speed)
                                    throws GtuException

Description copied from interface: LaneBasedStrategicalPlannerFactory

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.

Specified by:

peekDesiredHeadway in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalRoutePlanner>

Parameters:

gtuType - GTU type

speed - speed the GTU might be generated at

Returns:

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

Throws:

GtuException - on parameter exception or network exception

create

public final LaneBasedStrategicalRoutePlanner create(LaneBasedGtu gtu,
 Route route,
 Node origin,
 Node destination)
                                              throws GtuException

Description copied from interface: LaneBasedStrategicalPlannerFactory

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

Specified by:

create in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalRoutePlanner>

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:

GtuException - if the gtu is not suitable in any way for the creation of the strategical planner

nextParameters

protected final Parameters nextParameters(GtuType gtuType)
                                   throws GtuException

Returns the parameters for the next GTU.

Parameters:

gtuType - GTU type of GTU to be generated

Returns:

parameters for the next GTU

Throws:

GtuException - on parameter exception

toString

public final String toString()

Overrides:

toString in class Object