org.opentrafficsim.core.car

Class LaneBasedTemplateCar

java.lang.Object

org.opentrafficsim.core.gtu.AbstractGTU

org.opentrafficsim.core.gtu.lane.AbstractLaneBasedGTU

org.opentrafficsim.core.gtu.lane.AbstractLaneBasedTemplateGTU

org.opentrafficsim.core.car.LaneBasedTemplateCar

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface, GTU, LaneBasedGTU

public class LaneBasedTemplateCar
extends AbstractLaneBasedTemplateGTU

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 1329 $, $LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, by $Author: averbraeck $, initial version Oct 22, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LaneBasedTemplateCar.LaneBasedTemplateCarBuilder Build a template car and use easy setter methods to instantiate the car.

Constructor Summary

Constructors

Constructor and Description
LaneBasedTemplateCar(String id, TemplateGTUType templateGtuType, GTUFollowingModel gtuFollowingModel, Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions, org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed, CompleteLaneBasedRouteNavigator routeNavigator)
LaneBasedTemplateCar(String id, TemplateGTUType templateGtuType, GTUFollowingModel gtuFollowingModel, Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions, org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed, CompleteLaneBasedRouteNavigator routeNavigator, Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)

Method Summary

Modifier and Type	Method and Description
void	destroy() destroy the vehicle from the simulation and animation.
RelativePosition	getFront()
RelativePosition	getRear()
Map<RelativePosition.TYPE,RelativePosition>	getRelativePositions()
String	toString()

Methods inherited from class org.opentrafficsim.core.gtu.lane.AbstractLaneBasedTemplateGTU

getGTUType, getLength, getMaximumVelocity, getSimulator, getWidth

Methods inherited from class org.opentrafficsim.core.gtu.lane.AbstractLaneBasedGTU

bestAccessibleAdjacentLane, deltaTimeForDistance, enterLane, fractionalPosition, fractionalPosition, fractionalPositions, fractionalPositions, getAcceleration, getAcceleration, getBounds, getGTUFollowingModel, getLaneChangeDistanceAndDirection, getLanes, getLastEvaluationTime, getLateralVelocity, getLocation, getLongitudinalVelocity, getLongitudinalVelocity, getNextEvaluationTime, getOdometer, getVelocity, headway, headway, leaveLane, leaveLane, move, parallel, parallel, position, position, positions, positions, projectedPosition, timeAtDistance, toString

Methods inherited from class org.opentrafficsim.core.gtu.AbstractGTU

getId, getReference, getRouteNavigator, setRouteNavigator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.core.gtu.GTU

getId, getReference

Constructor Detail

LaneBasedTemplateCar

public LaneBasedTemplateCar(String id,
                            TemplateGTUType templateGtuType,
                            GTUFollowingModel gtuFollowingModel,
                            Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions,
                            org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed,
                            CompleteLaneBasedRouteNavigator routeNavigator)
                     throws NamingException,
                            RemoteException,
                            NetworkException,
                            nl.tudelft.simulation.dsol.SimRuntimeException,
                            GTUException

Parameters:

id - ID; the id of the GTU

templateGtuType - the template of the GTU

gtuFollowingModel - GTUFollowingModel; the following model, including a reference to the simulator

initialLongitudinalPositions - Map<Lane, DoubleScalar.Rel<LengthUnit>>; the initial positions of the car on one or more lanes

initialSpeed - DoubleScalar.Abs<SpeedUnit>; the initial speed of the car on the lane

routeNavigator - Route of the GTU

Throws:

NamingException - if an error occurs when adding the animation handler.

RemoteException - when the simulator cannot be reached.

NetworkException - when the GTU cannot be placed on the given lane.

nl.tudelft.simulation.dsol.SimRuntimeException - when the move method cannot be scheduled.

GTUException - when gtuFollowingModel is null

LaneBasedTemplateCar

public LaneBasedTemplateCar(String id,
                            TemplateGTUType templateGtuType,
                            GTUFollowingModel gtuFollowingModel,
                            Map<Lane,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.LengthUnit>> initialLongitudinalPositions,
                            org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.SpeedUnit> initialSpeed,
                            CompleteLaneBasedRouteNavigator routeNavigator,
                            Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass)
                     throws NamingException,
                            RemoteException,
                            NetworkException,
                            nl.tudelft.simulation.dsol.SimRuntimeException,
                            GTUException

Parameters:

id - ID; the id of the GTU

templateGtuType - the template of the GTU

gtuFollowingModel - GTUFollowingModel; the following model, including a reference to the simulator

initialLongitudinalPositions - Map<Lane, DoubleScalar.Rel<LengthUnit>>; the initial positions of the car on one or more lanes

initialSpeed - DoubleScalar.Abs<SpeedUnit>; the initial speed of the car on the lane

routeNavigator - Route; the route of the new car

animationClass - Class<? extends Renderable2D>; the class for animation or null if no animation.

Throws:

NamingException - if an error occurs when adding the animation handler.

RemoteException - when the simulator cannot be reached.

NetworkException - when the GTU cannot be placed on the given lane.

nl.tudelft.simulation.dsol.SimRuntimeException - when the move method cannot be scheduled.

GTUException - when gtuFollowingModel is null

Method Detail

getFront

public RelativePosition getFront()

Returns:

the front position of the GTU, relative to its reference point.

getRear

public RelativePosition getRear()

Returns:

the rear position of the GTU, relative to its reference point.

getRelativePositions

public final Map<RelativePosition.TYPE,RelativePosition> getRelativePositions()

Returns:

the positions for this GTU.

destroy

public final void destroy()

destroy the vehicle from the simulation and animation.

Specified by:

destroy in interface GTU

Overrides:

destroy in class AbstractLaneBasedGTU

toString

public final String toString()

Overrides:

toString in class Object