AbstractLaneBasedStrategicalPlannerFactory.java

package org.opentrafficsim.road.gtu.strategical;

import org.djunits.value.vdouble.scalar.Length;
import org.djunits.value.vdouble.scalar.Speed;
import org.opentrafficsim.base.parameters.ParameterException;
import org.opentrafficsim.base.parameters.Parameters;
import org.opentrafficsim.core.gtu.GTUException;
import org.opentrafficsim.core.gtu.GTUType;
import org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterFactory;
import org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterFactoryDefault;
import org.opentrafficsim.road.gtu.lane.LaneBasedGTU;
import org.opentrafficsim.road.gtu.lane.tactical.LaneBasedTacticalPlanner;
import org.opentrafficsim.road.gtu.lane.tactical.LaneBasedTacticalPlannerFactory;

/**
 * Factory for creating {@code LaneBasedStrategicalRoutePlanner} using any {@code LaneBasedTacticalPlannerFactory}. This
 * abstract class deals with forwarding peeking from the GTU generator to the tactical planner factory. Parameters are set using
 * a {@code ParameterFactory}, after the method {@code setParameters()} has been called, which subclasses need to implement.
 * <p>
 * Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
 * <p>
 * @version $Revision$, $LastChangedDate$, by $Author$, initial version 12 jan. 2018 <br>
 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
 * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
 * @param <T> class of the strategical planner generated
 */
public abstract class AbstractLaneBasedStrategicalPlannerFactory<T extends LaneBasedStrategicalPlanner>
        implements LaneBasedStrategicalPlannerFactory<T>
{

    /** Factory for tactical planners. */
    private final LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory;

    /** Parameter factory. */
    private final ParameterFactory parameterFactory;

    /** Peeked parameters. */
    private Parameters peekedParameters = null;

    /**
     * Constructor with factory for tactical planners.
     * @param tacticalPlannerFactory factory for tactical planners
     */
    public AbstractLaneBasedStrategicalPlannerFactory(
            final LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory)
    {
        this.tacticalPlannerFactory = tacticalPlannerFactory;
        this.parameterFactory = new ParameterFactoryDefault();
    }

    /**
     * Constructor with factory for tactical planners.
     * @param tacticalPlannerFactory factory for tactical planners
     * @param parametersFactory factory for parameters
     */
    public AbstractLaneBasedStrategicalPlannerFactory(
            final LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> tacticalPlannerFactory,
            final ParameterFactory parametersFactory)
    {
        this.tacticalPlannerFactory = tacticalPlannerFactory;
        this.parameterFactory = parametersFactory;
    }

    /** {@inheritDoc} */
    @Override
    public final Speed peekDesiredSpeed(final GTUType gtuType, final Speed speedLimit, final Speed maxGtuSpeed)
            throws GTUException
    {
        return this.tacticalPlannerFactory.peekDesiredSpeed(gtuType, speedLimit, maxGtuSpeed, peekParameters(gtuType));
    }

    /** {@inheritDoc} */
    @Override
    public final Length peekDesiredHeadway(final GTUType gtuType, final Speed speed) throws GTUException
    {
        return this.tacticalPlannerFactory.peekDesiredHeadway(gtuType, speed, peekParameters(gtuType));
    }

    /**
     * Determine or return the next parameter set.
     * @param gtuType GTUType; GTU type to generate parameters for
     * @return Parameters; next parameter set
     * @throws GTUException on parameter exception
     */
    private Parameters peekParameters(final GTUType gtuType) throws GTUException
    {
        if (this.peekedParameters != null)
        {
            return this.peekedParameters;
        }
        try
        {
            this.peekedParameters = this.tacticalPlannerFactory.getParameters();
            Parameters parameters = getParameters();
            if (parameters != null)
            {
                parameters.setAllIn(this.peekedParameters);
            }
            this.parameterFactory.setValues(this.peekedParameters, gtuType);
        }
        catch (ParameterException exception)
        {
            throw new GTUException("Parameter was set to illegal value.", exception);
        }
        return this.peekedParameters;
    }

    /**
     * Returns parameters specific to the strategical planner. The input already contains parameters from the tactical planner.
     * After this method, the {@code ParameterFactory} sets or overwrites additional parameters. Hence, this method may set
     * default (distributed) values for parameters specific to the strategical planner.
     * @return parameters Parameters; parameters for the strategical planner, may be {@code null}
     */
    protected abstract Parameters getParameters();

    /**
     * Returns the parameters for the next GTU.
     * @param gtuType GTUType; GTU type of GTU to be generated
     * @return Parameters; parameters for the next GTU
     * @throws GTUException on parameter exception
     */
    protected final Parameters nextParameters(final GTUType gtuType) throws GTUException
    {
        Parameters parameters = peekParameters(gtuType);
        this.peekedParameters = null;
        return parameters;
    }

    /**
     * Returns the next tactical planner.
     * @param gtu LaneBasedGTU; GTU to be generated
     * @return T; next tactical planner
     * @throws GTUException on exception during tactical planner creation
     */
    protected final LaneBasedTacticalPlanner nextTacticalPlanner(final LaneBasedGTU gtu) throws GTUException
    {
        return this.tacticalPlannerFactory.create(gtu);
    }

    /**
     * Returns the tactical planner factory.
     * @return LaneBasedTacticalPlannerFactory; tactical planner factory
     */
    protected final LaneBasedTacticalPlannerFactory<? extends LaneBasedTacticalPlanner> getTacticalPlannerFactory()
    {
        return this.tacticalPlannerFactory;
    }

}