org.opentrafficsim.road.gtu.strategical.route

Class LaneBasedStrategicalRoutePlannerFactory

java.lang.Object

org.opentrafficsim.road.gtu.strategical.route.LaneBasedStrategicalRoutePlannerFactory

All Implemented Interfaces:

Serializable, LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner>

public class LaneBasedStrategicalRoutePlannerFactory
extends Object
implements LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner>, Serializable

Factory for creating LaneBasedStrategicalRoutePlanner using any LaneBasedTacticalPlannerFactory.

Copyright (c) 2013-2016 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 Aug 2, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory) Constructor with factory for tactical planners.
LaneBasedStrategicalRoutePlannerFactory(LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory, org.opentrafficsim.core.network.route.RouteGenerator routeGenerator) Constructor with factory for tactical planners and route generator.

Method Summary

Modifier and Type	Method and Description
LaneBasedStrategicalPlanner	create(LaneBasedGTU gtu) Creates a new strategical planner for the given GTU.
org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics	getDefaultBehavioralCharacteristics() Returns a set of behavioral characteristics with default values for the next strategical planner that will be generated.
void	setBehavioralCharacteristics(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics) Set behavioral characteristics to use with the next creation of a strategical planner.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

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,
                                               org.opentrafficsim.core.network.route.RouteGenerator routeGenerator)

Constructor with factory for tactical planners and route generator.

Parameters:

tacticalPlannerFactory - factory for tactical planners

routeGenerator - route generator

Method Detail

getDefaultBehavioralCharacteristics

public final org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics getDefaultBehavioralCharacteristics()

Returns a set of behavioral characteristics with default values for the next strategical planner that will be generated.

Specified by:

getDefaultBehavioralCharacteristics in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner>

Returns:

set of behavioral characteristics with default values for the next strategical planner that will be generated

setBehavioralCharacteristics

public final void setBehavioralCharacteristics(org.opentrafficsim.core.gtu.behavioralcharacteristics.BehavioralCharacteristics behavioralCharacteristics)

Set behavioral characteristics to use with the next creation of a strategical planner. Only the next planner will use this.

Specified by:

setBehavioralCharacteristics in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner>

Parameters:

behavioralCharacteristics - behavioral characteristics to use with the next creation of a strategical planner

create

public final LaneBasedStrategicalPlanner create(LaneBasedGTU gtu)
                                         throws org.opentrafficsim.core.gtu.GTUException

Creates a new strategical planner for the given GTU. If no default behavioral characteristics are set, the default values will be used.

Specified by:

create in interface LaneBasedStrategicalPlannerFactory<LaneBasedStrategicalPlanner>

Parameters:

gtu - GTU

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

toString

public final String toString()

Overrides:

toString in class Object