org.opentrafficsim.road.gtu.lane

Interface LaneBasedGTUCharacteristicsGenerator

All Known Implementing Classes:

LaneBasedTemplateGTUType, LaneBasedTemplateGTUTypeDistribution

public interface LaneBasedGTUCharacteristicsGenerator

Interface for objects that can generate a LaneBasedGTUCharacteristics object.

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 Mar 9, 2016

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
LaneBasedGTUCharacteristics	draw() Generate a LaneBasedGTUCharacteristics object.
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	getSimulator() Return the simulator.

Method Detail

draw

LaneBasedGTUCharacteristics draw()
                          throws org.opentrafficsim.core.distributions.ProbabilityException,
                                 org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException,
                                 org.opentrafficsim.core.gtu.GTUException

Generate a LaneBasedGTUCharacteristics object.

Returns:

LaneBasedGTUCharacteristics

Throws:

org.opentrafficsim.core.distributions.ProbabilityException - when the generator is improperly configured

org.opentrafficsim.core.gtu.behavioralcharacteristics.ParameterException - in case of a parameter problem.

org.opentrafficsim.core.gtu.GTUException - if strategical planner cannot be created

getSimulator

org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface getSimulator()
                                                             throws org.opentrafficsim.core.distributions.ProbabilityException

Return the simulator.

Returns:

OTSDEVSSimulatorInterface; the simulator

Throws:

org.opentrafficsim.core.distributions.ProbabilityException - when the generator cannot retrieve the simulator