org.opentrafficsim.road.gtu.lane

Class LaneBasedIndividualGTU

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.gtu.AbstractGTU

org.opentrafficsim.road.gtu.lane.AbstractLaneBasedGTU

org.opentrafficsim.road.gtu.lane.AbstractLaneBasedIndividualGTU

org.opentrafficsim.road.gtu.lane.LaneBasedIndividualGTU

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.base.Identifiable, org.opentrafficsim.core.gtu.GTU, LaneBasedGTU

public class LaneBasedIndividualGTU
extends AbstractLaneBasedIndividualGTU

Augments the AbstractLaneBasedIndividualGTU with a LaneBasedIndividualCarBuilder and animation support

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

Version:

$Revision: 1401 $, $LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 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	LaneBasedIndividualGTU.LaneBasedIndividualCarBuilder Build an individual car and use easy setter methods to instantiate the car.

Field Summary

Fields inherited from class org.opentrafficsim.road.gtu.lane.AbstractLaneBasedGTU

CACHED_POSITION, CACHING, initialLocationThresholdDifference, NON_CACHED_POSITION

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

ALIGN_COUNT, ALIGNED, operationalPlan

Fields inherited from class nl.tudelft.simulation.event.EventProducer

listeners

Fields inherited from interface org.opentrafficsim.road.gtu.lane.LaneBasedGTU

LANE_CHANGE_EVENT, LANE_ENTER_EVENT, LANE_EXIT_EVENT, LANEBASED_DESTROY_EVENT, LANEBASED_INIT_EVENT, LANEBASED_MOVE_EVENT, LINK_ENTER_EVENT, LINK_EXIT_EVENT

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

DESTROY_EVENT, INIT_EVENT, MOVE_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor and Description

LaneBasedIndividualGTU(String id, org.opentrafficsim.core.gtu.GTUType gtuType, org.djunits.value.vdouble.scalar.Length length, org.djunits.value.vdouble.scalar.Length width, org.djunits.value.vdouble.scalar.Speed maximumSpeed, org.djunits.value.vdouble.scalar.Length front, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator, org.opentrafficsim.core.network.OTSNetwork network) Construct a new LaneBasedIndividualCar.

Method Summary

Modifier and Type	Method and Description
void	destroy()
org.opentrafficsim.core.gtu.RelativePosition	getCenter()
nl.tudelft.simulation.immutablecollections.ImmutableSet<org.opentrafficsim.core.gtu.RelativePosition>	getContourPoints()
org.opentrafficsim.core.gtu.RelativePosition	getFront()
org.opentrafficsim.core.gtu.RelativePosition	getRear()
nl.tudelft.simulation.immutablecollections.ImmutableMap<org.opentrafficsim.core.gtu.RelativePosition.TYPE,org.opentrafficsim.core.gtu.RelativePosition>	getRelativePositions()
void	initWithAnimation(LaneBasedStrategicalPlanner strategicalPlanner, Set<DirectedLanePosition> initialLongitudinalPositions, org.djunits.value.vdouble.scalar.Speed initialSpeed, Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D<? super LaneBasedIndividualGTU>> animationClass, org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer)
String	toString()

Methods inherited from class org.opentrafficsim.road.gtu.lane.AbstractLaneBasedIndividualGTU

getLength, getMaximumSpeed, getWidth, laneChangeAllowed, setNoLaneChangeDistance

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

addGtuToLane, addTrigger, changeLaneInstantaneously, enterLane, finalizeLaneChange, fractionalPosition, fractionalPosition, fractionalPositions, fractionalPositions, getBounds, getCarFollowingAcceleration, getDesiredSpeed, getDirection, getReferencePosition, getStrategicalPlanner, getStrategicalPlanner, getTurnIndicatorStatus, getTurnIndicatorStatus, getVehicleModel, init, initLaneChange, isSafeToChange, leaveLane, leaveLane, move, position, position, positions, positions, projectedPosition, reinit, scheduleEnterLeaveTriggers, setParent, setTurnIndicatorStatus, setVehicleModel, translatedPosition

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

addGtu, equals, getAcceleration, getAcceleration, getBaseColor, getChildren, getGTUType, getId, getLocation, getMaximumAcceleration, getMaximumDeceleration, getOdometer, getOdometer, getOperationalPlan, getOperationalPlan, getParameters, getParent, getPerceivableContext, getReference, getSimulator, getSpeed, getSpeed, hashCode, init, interruptMove, isDestroyed, removeGtu, setMaximumAcceleration, setMaximumDeceleration, setParameters

Methods inherited from class nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.road.gtu.lane.LaneBasedGTU

getLocation, getTacticalPlanner, getTacticalPlanner, isBrakingLightsOn, isBrakingLightsOn

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

addGtu, getAcceleration, getAcceleration, getBaseColor, getChildren, getGTUType, getId, getMaximumAcceleration, getMaximumDeceleration, getOdometer, getOdometer, getOperationalPlan, getOperationalPlan, getParameters, getParent, getReference, getSimulator, getSpeed, getSpeed, isDestroyed, removeGtu, setParameters

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, removeListener

Constructor Detail

LaneBasedIndividualGTU

public LaneBasedIndividualGTU(String id,
                              org.opentrafficsim.core.gtu.GTUType gtuType,
                              org.djunits.value.vdouble.scalar.Length length,
                              org.djunits.value.vdouble.scalar.Length width,
                              org.djunits.value.vdouble.scalar.Speed maximumSpeed,
                              org.djunits.value.vdouble.scalar.Length front,
                              nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit simulator,
                              org.opentrafficsim.core.network.OTSNetwork network)
                       throws NamingException,
                              org.opentrafficsim.core.gtu.GTUException

Construct a new LaneBasedIndividualCar.

Parameters:

id - ID; the id of the GTU

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

length - Length; the maximum length of the GTU (parallel with driving direction)

width - Length; the maximum width of the GTU (perpendicular to driving direction)

maximumSpeed - Speed;the maximum speed of the GTU (in the driving direction)

front - Length; front distance relative to the reference position

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator

network - the network that the GTU is initially registered in

Throws:

NamingException - if an error occurs when adding the animation handler

org.opentrafficsim.core.gtu.GTUException - when a parameter is invalid

Method Detail

initWithAnimation

public final void initWithAnimation(LaneBasedStrategicalPlanner strategicalPlanner,
                                    Set<DirectedLanePosition> initialLongitudinalPositions,
                                    org.djunits.value.vdouble.scalar.Speed initialSpeed,
                                    Class<? extends nl.tudelft.simulation.dsol.animation.D2.Renderable2D<? super LaneBasedIndividualGTU>> animationClass,
                                    org.opentrafficsim.core.gtu.animation.GTUColorer gtuColorer)
                             throws org.opentrafficsim.core.network.NetworkException,
                                    nl.tudelft.simulation.dsol.SimRuntimeException,
                                    org.opentrafficsim.core.gtu.GTUException,
                                    org.opentrafficsim.core.geometry.OTSGeometryException

Parameters:

strategicalPlanner - the strategical planner (e.g., route determination) to use

initialLongitudinalPositions - the initial positions of the car on one or more lanes with their directions

initialSpeed - the initial speed of the car on the lane

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:

org.opentrafficsim.core.network.NetworkException - when the GTU cannot be placed on the given lane

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

org.opentrafficsim.core.gtu.GTUException - when initial values are not correct

org.opentrafficsim.core.geometry.OTSGeometryException - when the initial path is wrong

getFront

public final org.opentrafficsim.core.gtu.RelativePosition getFront()

getRear

public final org.opentrafficsim.core.gtu.RelativePosition getRear()

getCenter

public final org.opentrafficsim.core.gtu.RelativePosition getCenter()

getRelativePositions

public final nl.tudelft.simulation.immutablecollections.ImmutableMap<org.opentrafficsim.core.gtu.RelativePosition.TYPE,org.opentrafficsim.core.gtu.RelativePosition> getRelativePositions()

getContourPoints

public final nl.tudelft.simulation.immutablecollections.ImmutableSet<org.opentrafficsim.core.gtu.RelativePosition> getContourPoints()

destroy

public final void destroy()

Specified by:

destroy in interface org.opentrafficsim.core.gtu.GTU

Overrides:

destroy in class AbstractLaneBasedGTU

toString

public final String toString()

Overrides:

toString in class AbstractLaneBasedGTU