org.opentrafficsim.core.car

Class LaneBasedTemplateCar<ID>

java.lang.Object

org.opentrafficsim.core.gtu.AbstractGTU<ID>

org.opentrafficsim.core.gtu.lane.AbstractLaneBasedGTU<ID>

org.opentrafficsim.core.gtu.lane.AbstractLaneBasedTemplateGTU<ID>

org.opentrafficsim.core.car.LaneBasedTemplateCar<ID>

Type Parameters:

ID - The type of ID, e.g., String or Integer

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface, GTU<ID>, LaneBasedGTU<ID>

public class LaneBasedTemplateCar<ID>
extends AbstractLaneBasedTemplateGTU<ID>

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

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<ID> Build a template car and use easy setter methods to instantiate the car.

Field Summary

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

odometer

Constructor Summary

Constructors

Constructor and Description
LaneBasedTemplateCar(ID id, TemplateGTUType<?> templateGtuType, GTUFollowingModel gtuFollowingModel, Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions, DoubleScalar.Abs<SpeedUnit> initialSpeed, Route route)
LaneBasedTemplateCar(ID id, TemplateGTUType<?> templateGtuType, GTUFollowingModel gtuFollowingModel, Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions, DoubleScalar.Abs<SpeedUnit> initialSpeed, Route route, 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

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

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

getId, getReference, getRoute, setRoute

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(ID id,
                            TemplateGTUType<?> templateGtuType,
                            GTUFollowingModel gtuFollowingModel,
                            Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions,
                            DoubleScalar.Abs<SpeedUnit> initialSpeed,
                            Route route)
                     throws NamingException,
                            RemoteException,
                            NetworkException,
                            nl.tudelft.simulation.dsol.SimRuntimeException,
                            GTUException

Parameters:

id - ID; the id of the GTU, could be String or Integer

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

route - 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(ID id,
                            TemplateGTUType<?> templateGtuType,
                            GTUFollowingModel gtuFollowingModel,
                            Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions,
                            DoubleScalar.Abs<SpeedUnit> initialSpeed,
                            Route route,
                            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, could be String or Integer

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

route - 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<ID>

Overrides:

destroy in class AbstractLaneBasedGTU<ID>

toString

public final String toString()

Overrides:

toString in class Object