Package org.opentrafficsim.core.gtu.plan.strategical

Interface StrategicalPlannerFactory<T extends StrategicalPlanner>

Type Parameters:
T - class of the strategical planner generated
public interface StrategicalPlannerFactory<T extends StrategicalPlanner>
A factory class is used to generate strategical planners as the strategical planner is state-full.

Copyright (c) 2013-2019 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 Description
    T create​(GTU gtu)
    Creates a new strategical planner for the given GTU.
    Parameters getDefaultParameters()
    Returns a set of parameters with default values for the next strategical planner that will be generated.
    void setParameters​(Parameters parameters)
    Set parameters to use with the next creation of a strategical planner.

  • Method Details

    • getDefaultParameters

      Parameters getDefaultParameters()
      Returns a set of parameters with default values for the next strategical planner that will be generated.
      Returns:
      set of parameters with default values for the next strategical planner that will be generated

    • setParameters

      void setParameters​(Parameters parameters)
      Set parameters to use with the next creation of a strategical planner. Only the next planner will use this.
      Parameters:
      parameters - Parameters; parameters to use with the next creation of a strategical planner

    • create

      T create​(GTU gtu) throws GTUException
      Creates a new strategical planner for the given GTU. If no default parameters are set, the default values will be used.
      Parameters:
      gtu - GTU; GTU
      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