org.opentrafficsim.core.car

Class LaneBasedIndividualCar<ID>

java.lang.Object

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

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

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

org.opentrafficsim.core.car.LaneBasedIndividualCar<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 LaneBasedIndividualCar<ID>
extends AbstractLaneBasedIndividualGTU<ID>

Augments the AbstractLaneBasedIndividualGTU with a LaneBasedIndividualCarBuilder and animation support

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	LaneBasedIndividualCar.LaneBasedIndividualCarBuilder<ID> Build an individual 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
LaneBasedIndividualCar(ID id, GTUType<?> gtuType, GTUFollowingModel gtuFollowingModel, LaneChangeModel laneChangeModel, Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions, DoubleScalar.Abs<SpeedUnit> initialSpeed, DoubleScalar.Rel<LengthUnit> length, DoubleScalar.Rel<LengthUnit> width, DoubleScalar.Abs<SpeedUnit> maximumVelocity, Route route, OTSDEVSSimulatorInterface simulator)
LaneBasedIndividualCar(ID id, GTUType<?> gtuType, GTUFollowingModel gtuFollowingModel, LaneChangeModel laneChangeModel, Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions, DoubleScalar.Abs<SpeedUnit> initialSpeed, DoubleScalar.Rel<LengthUnit> length, DoubleScalar.Rel<LengthUnit> width, DoubleScalar.Abs<SpeedUnit> maximumVelocity, Route route, OTSDEVSSimulatorInterface simulator, Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass, GTUColorer gtuColorer) Construct a new LaneBasedIndividualCar.

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.AbstractLaneBasedIndividualGTU

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

getGTUType, 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

getGTUType, getId, getReference

Constructor Detail

LaneBasedIndividualCar

public LaneBasedIndividualCar(ID id,
                              GTUType<?> gtuType,
                              GTUFollowingModel gtuFollowingModel,
                              LaneChangeModel laneChangeModel,
                              Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions,
                              DoubleScalar.Abs<SpeedUnit> initialSpeed,
                              DoubleScalar.Rel<LengthUnit> length,
                              DoubleScalar.Rel<LengthUnit> width,
                              DoubleScalar.Abs<SpeedUnit> maximumVelocity,
                              Route route,
                              OTSDEVSSimulatorInterface simulator)
                       throws NamingException,
                              RemoteException,
                              NetworkException,
                              nl.tudelft.simulation.dsol.SimRuntimeException,
                              GTUException

Parameters:

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

gtuType - GTUType<?>; the type of GTU, e.g. TruckType, CarType, BusType

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

laneChangeModel - LaneChangeModel; the lane change model

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

length - DoubleScalar.Rel<LengthUnit>; the maximum length of the GTU (parallel with driving direction)

width - DoubleScalar.Rel<LengthUnit>; the maximum width of the GTU (perpendicular to driving direction)

maximumVelocity - DoubleScalar.Abs<SpeedUnit>;the maximum speed of the GTU (in the driving direction)

route - Route; the route that the GTU will follow

simulator - OTSDEVSSimulatorInterface; the simulator

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 a parameter is invalid

LaneBasedIndividualCar

public LaneBasedIndividualCar(ID id,
                              GTUType<?> gtuType,
                              GTUFollowingModel gtuFollowingModel,
                              LaneChangeModel laneChangeModel,
                              Map<Lane,DoubleScalar.Rel<LengthUnit>> initialLongitudinalPositions,
                              DoubleScalar.Abs<SpeedUnit> initialSpeed,
                              DoubleScalar.Rel<LengthUnit> length,
                              DoubleScalar.Rel<LengthUnit> width,
                              DoubleScalar.Abs<SpeedUnit> maximumVelocity,
                              Route route,
                              OTSDEVSSimulatorInterface simulator,
                              Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D> animationClass,
                              GTUColorer gtuColorer)
                       throws NamingException,
                              RemoteException,
                              NetworkException,
                              nl.tudelft.simulation.dsol.SimRuntimeException,
                              GTUException

Construct a new LaneBasedIndividualCar.

Parameters:

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

gtuType - GTUTYpe<?>; the type of GTU, e.g. TruckType, CarType, BusType

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

laneChangeModel - LaneChangeModel; the lane change model

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

length - DoubleScalar.Rel<LengthUnit>; the maximum length of the GTU (parallel with driving direction)

width - DoubleScalar.Rel<LengthUnit>; the maximum width of the GTU (perpendicular to driving direction)

maximumVelocity - DoubleScalar.Abs<SpeedUnit>;the maximum speed of the GTU (in the driving direction)

route - Route the route that the GTU will follow

simulator - OTSDEVSSimulatorInterface; the simulator

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

gtuColorer - GTUColorer; the GTUColorer that will be linked from the animation to determine the color (may be null in which case a default will be used)

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 a parameter is invalid

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