DefaultGTUCharacteristicsGeneratorOD.java
package org.opentrafficsim.road.gtu.generator.od;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import org.djutils.exceptions.Throw;
import org.djutils.exceptions.Try;
import org.opentrafficsim.core.distributions.Generator;
import org.opentrafficsim.core.gtu.GTUCharacteristics;
import org.opentrafficsim.core.gtu.GTUException;
import org.opentrafficsim.core.gtu.GTUType;
import org.opentrafficsim.core.gtu.TemplateGTUType;
import org.opentrafficsim.core.network.Node;
import org.opentrafficsim.core.network.route.Route;
import org.opentrafficsim.road.gtu.generator.characteristics.LaneBasedGTUCharacteristics;
import org.opentrafficsim.road.gtu.lane.VehicleModel;
import org.opentrafficsim.road.gtu.lane.VehicleModelFactory;
import org.opentrafficsim.road.gtu.strategical.LaneBasedStrategicalPlannerFactory;
import org.opentrafficsim.road.gtu.strategical.od.Categorization;
import org.opentrafficsim.road.gtu.strategical.od.Category;
import org.opentrafficsim.road.gtu.strategical.route.RouteGeneratorOD;
import nl.tudelft.simulation.jstats.streams.StreamInterface;
/**
* Default generator for {@code LaneBasedGTUCharacteristics}.
* <p>
* Copyright (c) 2013-2019 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 10 dec. 2017 <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>
*/
public final class DefaultGTUCharacteristicsGeneratorOD implements GTUCharacteristicsGeneratorOD
{
/** GTU type generator. */
private Generator<GTUType> gtuTypeGenerator = null;
/** Templates. */
private final Map<GTUType, TemplateGTUType> templates = new LinkedHashMap<>();
/** Route generator. */
private final RouteGeneratorOD routeGenerator;
/** Supplies a strategical factory. */
private final StrategicalPlannerFactorySupplierOD factorySupplier;
/** Vehicle factory. */
private VehicleModelFactory vehicleModelFactory = VehicleModelFactory.MINMAX;
/**
* Constructor using null-routes, default GTU characteristics and LMRS.
*/
public DefaultGTUCharacteristicsGeneratorOD()
{
this(null, RouteGeneratorOD.NULL, new HashSet<>(), StrategicalPlannerFactorySupplierOD.lmrs());
}
/**
* Constructor using route generator, default GTU characteristics and LMRS.
* @param routeGenerator RouteGeneratorOD; route generator
*/
public DefaultGTUCharacteristicsGeneratorOD(final RouteGeneratorOD routeGenerator)
{
this(null, routeGenerator, new HashSet<>(), StrategicalPlannerFactorySupplierOD.lmrs());
}
/**
* Constructor using route supplier, provided GTU templates and LMRS.
* @param routeSupplier RouteGeneratorOD; route supplier
* @param templates Set<TemplateGTUType>; templates
*/
public DefaultGTUCharacteristicsGeneratorOD(final RouteGeneratorOD routeSupplier, final Set<TemplateGTUType> templates)
{
this(null, routeSupplier, templates, StrategicalPlannerFactorySupplierOD.lmrs());
}
/**
* Constructor using route supplier, default GTU characteristics and provided strategical planner factory supplier.
* @param routeGenerator RouteGeneratorOD; route generator
* @param factorySupplier StrategicalPlannerFactorySupplierOD; strategical factory supplier
*/
public DefaultGTUCharacteristicsGeneratorOD(final RouteGeneratorOD routeGenerator,
final StrategicalPlannerFactorySupplierOD factorySupplier)
{
this(null, routeGenerator, new HashSet<>(), factorySupplier);
}
/**
* Constructor using route supplier, provided GTU templates and provided strategical planner factory supplier.
* @param gtuTypeGenerator Generator<GTUType>; GTU type generator
* @param routeGenerator RouteGeneratorOD; route generator
* @param templates Set<TemplateGTUType>; templates
* @param factorySupplier StrategicalPlannerFactorySupplierOD; strategical factory supplier
*/
public DefaultGTUCharacteristicsGeneratorOD(final Generator<GTUType> gtuTypeGenerator,
final RouteGeneratorOD routeGenerator, final Set<TemplateGTUType> templates,
final StrategicalPlannerFactorySupplierOD factorySupplier)
{
Throw.whenNull(factorySupplier, "Strategical factory supplier may not be null.");
this.gtuTypeGenerator = gtuTypeGenerator;
if (routeGenerator == null)
{
this.routeGenerator = RouteGeneratorOD.NULL;
}
else
{
this.routeGenerator = routeGenerator;
}
if (templates != null)
{
for (TemplateGTUType template : templates)
{
this.templates.put(template.getGTUType(), template);
}
}
this.factorySupplier = factorySupplier;
}
/**
* Constructor using null-routes, provided GTU templates and LMRS.
* @param templates Set<TemplateGTUType>; templates
*/
public DefaultGTUCharacteristicsGeneratorOD(final Set<TemplateGTUType> templates)
{
this(null, RouteGeneratorOD.NULL, templates, StrategicalPlannerFactorySupplierOD.lmrs());
}
/**
* Constructor using null-routes, provided GTU templates and provided strategical planner factory supplier.
* @param templates Set<TemplateGTUType>; templates
* @param factorySupplier StrategicalPlannerFactorySupplierOD; strategical factory supplier
*/
public DefaultGTUCharacteristicsGeneratorOD(final Set<TemplateGTUType> templates,
final StrategicalPlannerFactorySupplierOD factorySupplier)
{
this(null, RouteGeneratorOD.NULL, templates, factorySupplier);
}
/**
* Constructor using using null-routes, default GTU characteristics and provided GTU templates and provided strategical
* planner factory supplier.
* @param factorySupplier StrategicalPlannerFactorySupplierOD; strategical factory supplier
*/
public DefaultGTUCharacteristicsGeneratorOD(final StrategicalPlannerFactorySupplierOD factorySupplier)
{
this(null, RouteGeneratorOD.NULL, new HashSet<>(), factorySupplier);
}
// TODO: remove above constructors and use factory always
/**
* Constructor using route supplier, provided GTU templates and provided strategical planner factory supplier.
* @param gtuTypeGenerator Generator<GTUType>; GTU type generator
* @param routeSupplier RouteGeneratorOD; route supplier
* @param templates Set<TemplateGTUType>; templates
* @param factorySupplier StrategicalPlannerFactorySupplierOD; strategical factory supplier
* @param vehicleModelFactory VehicleModelFactory; vehicle model factory
*/
private DefaultGTUCharacteristicsGeneratorOD(final Generator<GTUType> gtuTypeGenerator,
final RouteGeneratorOD routeSupplier, final Set<TemplateGTUType> templates,
final StrategicalPlannerFactorySupplierOD factorySupplier, final VehicleModelFactory vehicleModelFactory)
{
Throw.whenNull(factorySupplier, "Strategical factory supplier may not be null.");
this.gtuTypeGenerator = gtuTypeGenerator;
if (routeSupplier == null)
{
this.routeGenerator = RouteGeneratorOD.NULL;
}
else
{
this.routeGenerator = routeSupplier;
}
if (templates != null)
{
for (TemplateGTUType template : templates)
{
this.templates.put(template.getGTUType(), template);
}
}
this.factorySupplier = factorySupplier;
if (vehicleModelFactory == null)
{
this.vehicleModelFactory = VehicleModelFactory.MINMAX;
}
else
{
this.vehicleModelFactory = vehicleModelFactory;
}
}
/** {@inheritDoc} */
@Override
public LaneBasedGTUCharacteristics draw(final Node origin, final Node destination, final Category category,
final StreamInterface randomStream) throws GTUException
{
Categorization categorization = category.getCategorization();
// GTU characteristics
GTUType gtuType;
if (categorization.entails(GTUType.class))
{
gtuType = category.get(GTUType.class);
}
else if (this.gtuTypeGenerator != null)
{
gtuType = Try.assign(() -> this.gtuTypeGenerator.draw(), GTUException.class, "Parameter while drawing GTU type.");
}
else
{
gtuType = GTUType.CAR;
}
GTUCharacteristics gtuCharacteristics;
if (this.templates.containsKey(gtuType))
{
gtuCharacteristics =
Try.assign(() -> this.templates.get(gtuType).draw(), "Exception while drawing GTU characteristics.");
}
else
{
gtuCharacteristics = Try.assign(() -> GTUType.defaultCharacteristics(gtuType, randomStream),
"Exception while applying default GTU characteristics.");
}
// strategical factory
LaneBasedStrategicalPlannerFactory<?> laneBasedStrategicalPlannerFactory =
this.factorySupplier.getFactory(origin, destination, category, randomStream);
// route
Route route;
if (categorization.entails(Route.class))
{
route = category.get(Route.class);
}
else
{
// get route from supplier
route = this.routeGenerator.getRoute(origin, destination, gtuType);
}
// vehicle model
VehicleModel vehicleModel = this.vehicleModelFactory.create(gtuType);
return new LaneBasedGTUCharacteristics(gtuCharacteristics, laneBasedStrategicalPlannerFactory, route, origin,
destination, vehicleModel);
}
/**
* Factory for {@code DefaultGTUCharacteristicsGeneratorOD}.
* <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 8 jan. 2019 <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>
*/
@SuppressWarnings("hiddenfield")
public static class Factory
{
/** GTU type. */
private Generator<GTUType> gtuTypeGenerator = null;
/** Templates. */
private Set<TemplateGTUType> templates = new LinkedHashSet<>();
/** Route supplier. */
private RouteGeneratorOD routeGenerator = RouteGeneratorOD.NULL;
/** Supplies a strategical factory. */
private StrategicalPlannerFactorySupplierOD factorySupplier = StrategicalPlannerFactorySupplierOD.lmrs();
/** Vehicle factory. */
private VehicleModelFactory vehicleModelFactory = VehicleModelFactory.MINMAX;
/**
* @param gtuTypeGenerator Generator<GTUType>; set gtuTypeGenerator.
* @return Factory; this factory for method chaining
*/
public Factory setGtuTypeGenerator(final Generator<GTUType> gtuTypeGenerator)
{
this.gtuTypeGenerator = gtuTypeGenerator;
return this;
}
/**
* @param templates Set<TemplateGTUType>; set templates.
* @return Factory; this factory for method chaining
*/
public Factory setTemplates(final Set<TemplateGTUType> templates)
{
this.templates = templates;
return this;
}
/**
* @param routeSupplier RouteGeneratorOD; set routeSupplier.
* @return Factory; this factory for method chaining
*/
public Factory setRouteSupplier(final RouteGeneratorOD routeSupplier)
{
this.routeGenerator = routeSupplier;
return this;
}
/**
* @param factorySupplier StrategicalPlannerFactorySupplierOD; set factorySupplier.
* @return Factory; this factory for method chaining
*/
public Factory setFactorySupplier(final StrategicalPlannerFactorySupplierOD factorySupplier)
{
this.factorySupplier = factorySupplier;
return this;
}
/**
* @param vehicleModelFactory VehicleModelFactory; set vehicleModelFactory.
* @return Factory; this factory for method chaining
*/
public Factory setVehicleModelGenerator(final VehicleModelFactory vehicleModelFactory)
{
this.vehicleModelFactory = vehicleModelFactory;
return this;
}
/**
* Creates the default GTU characteristics generator based on OD information.
* @return default GTU characteristics generator based on OD information
*/
@SuppressWarnings("synthetic-access")
public DefaultGTUCharacteristicsGeneratorOD create()
{
return new DefaultGTUCharacteristicsGeneratorOD(this.gtuTypeGenerator, this.routeGenerator, this.templates,
this.factorySupplier, this.vehicleModelFactory);
}
}
}