org.opentrafficsim.core.gtu

Class AbstractGTU

java.lang.Object

org.opentrafficsim.core.gtu.AbstractGTU

All Implemented Interfaces:

Serializable, LocatableInterface, GTU

Direct Known Subclasses:

AbstractLinkBasedGTU

public abstract class AbstractGTU
extends Object
implements GTU

Implements the basic functionalities of any GTU: the ability to move on 3D-space according to a plan.

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: 1889 $, $LastChangedDate: 2016-04-05 21:30:47 +0200 (Tue, 05 Apr 2016) $, by $Author: pknoppers $, initial version Oct 22, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractGTU(IdGenerator idGenerator, GTUType gtuType, OTSDEVSSimulatorInterface simulator, StrategicalPlanner strategicalPlanner, Perception perception, DirectedPoint initialLocation, org.djunits.value.vdouble.scalar.Speed initialSpeed, PerceivableContext perceivableContext)
AbstractGTU(String id, GTUType gtuType, OTSDEVSSimulatorInterface simulator, StrategicalPlanner strategicalPlanner, Perception perception, DirectedPoint initialLocation, org.djunits.value.vdouble.scalar.Speed initialSpeed, PerceivableContext perceivableContext)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destructor.
org.djunits.value.vdouble.scalar.Acceleration	getAcceleration()
org.djunits.value.vdouble.scalar.Acceleration	getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs time)
GTUType	getGTUType()
String	getId()
DirectedPoint	getLocation()
org.djunits.value.vdouble.scalar.Acceleration	getMaximumAcceleration()
org.djunits.value.vdouble.scalar.Acceleration	getMaximumDeceleration()
org.djunits.value.vdouble.scalar.Length.Rel	getOdometer()
OperationalPlan	getOperationalPlan()
PerceivableContext	getPerceivableContext()
Perception	getPerception()
RelativePosition	getReference()
OTSDEVSSimulatorInterface	getSimulator()
StrategicalPlanner	getStrategicalPlanner()
TacticalPlanner	getTacticalPlanner()
TurnIndicatorStatus	getTurnIndicatorStatus()
org.djunits.value.vdouble.scalar.Speed	getVelocity()
org.djunits.value.vdouble.scalar.Speed	getVelocity(org.djunits.value.vdouble.scalar.Time.Abs time)
protected void	interruptMove() Interrupt the move and ask for a new plan.
boolean	isDestroyed()
protected void	move(DirectedPoint fromLocation) Move from the current location according to an operational plan to a location that will bring us nearer to reaching the location provided by the strategical planner.
void	setMaximumAcceleration(org.djunits.value.vdouble.scalar.Acceleration maximumAcceleration)
void	setMaximumDeceleration(org.djunits.value.vdouble.scalar.Acceleration maximumDeceleration)
void	setTurnIndicatorStatus(TurnIndicatorStatus turnIndicatorStatus) Set the status of the turn indicator.

Methods inherited from class java.lang.Object

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

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

getBehavioralCharacteristics, getBounds, getFront, getLength, getMaximumVelocity, getRear, getRelativePositions, getWidth

Constructor Detail

AbstractGTU

public AbstractGTU(String id,
                   GTUType gtuType,
                   OTSDEVSSimulatorInterface simulator,
                   StrategicalPlanner strategicalPlanner,
                   Perception perception,
                   DirectedPoint initialLocation,
                   org.djunits.value.vdouble.scalar.Speed initialSpeed,
                   PerceivableContext perceivableContext)
            throws SimRuntimeException,
                   GTUException

Parameters:

id - String; the id of the GTU

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

simulator - OTSDEVSSimulatorInterface; the simulator to schedule plan changes on

strategicalPlanner - StrategicalPlanner; the strategical planner responsible for the overall 'mission' of the GTU, usually indicating where it needs to go. It operates by instantiating tactical planners to do the work.

perception - Perception; the perception unit that takes care of observing the environment of the GTU

initialLocation - DirectedPoint; the initial location (and direction) of the GTU

initialSpeed - Speed; the initial speed of the GTU

perceivableContext - PerceivableContext; the perceivable context in which this GTU will be registered

Throws:

SimRuntimeException - when scheduling after the first move fails

GTUException - when the preconditions of the constructor are not met or when the construction of the original waiting path fails

AbstractGTU

public AbstractGTU(IdGenerator idGenerator,
                   GTUType gtuType,
                   OTSDEVSSimulatorInterface simulator,
                   StrategicalPlanner strategicalPlanner,
                   Perception perception,
                   DirectedPoint initialLocation,
                   org.djunits.value.vdouble.scalar.Speed initialSpeed,
                   PerceivableContext perceivableContext)
            throws SimRuntimeException,
                   GTUException

Parameters:

idGenerator - IdGenerator; the generator that will produce a unique id of the GTU

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

simulator - OTSDEVSSimulatorInterface; the simulator to schedule plan changes on

strategicalPlanner - StrategicalPlanner; the strategical planner responsible for the overall 'mission' of the GTU, usually indicating where it needs to go. It operates by instantiating tactical planners to do the work.

perception - Perception; the perception unit that takes care of observing the environment of the GTU

initialLocation - DirectedPoint; the initial location (and direction) of the GTU

initialSpeed - Speed; the initial speed of the GTU

perceivableContext - PerceivableContext; the perceivable context in which this GTU will be registered

Throws:

SimRuntimeException - when scheduling after the first move fails

GTUException - when the preconditions of the constructor are not met or when the construction of the original waiting path fails

Method Detail

destroy

public void destroy()

Destructor. Don't forget to call with super.destroy() from any override to avoid memory leaks in the network.

Specified by:

destroy in interface GTU

move

protected void move(DirectedPoint fromLocation)
             throws SimRuntimeException,
                    OperationalPlanException,
                    GTUException,
                    NetworkException

Move from the current location according to an operational plan to a location that will bring us nearer to reaching the location provided by the strategical planner.
This method can be overridden to carry out specific behavior during the execution of the plan (e.g., scheduling of triggers, entering or leaving lanes, etc.). Please bear in mind that the call to super.move() is essential, and that one has to take care to handle the situation that the plan gets interrupted.

Parameters:

fromLocation - the last known location (initial location, or end location of the previous operational plan)

Throws:

SimRuntimeException - when scheduling of the next move fails

OperationalPlanException - when there is a problem creating a good path for the GTU

GTUException - when there is a problem with the state of the GTU when planning a path

NetworkException - in case of a problem with the network, e.g., a dead end where it is not expected

interruptMove

protected void interruptMove()
                      throws SimRuntimeException,
                             OperationalPlanException,
                             GTUException,
                             NetworkException

Interrupt the move and ask for a new plan. This method can be overridden to carry out the bookkeeping needed when the current plan gets interrupted.

Throws:

OperationalPlanException - when there was a problem retrieving the location from the running plan

SimRuntimeException - when scheduling of the next move fails

OperationalPlanException - when there is a problem creating a good path for the GTU

GTUException - when there is a problem with the state of the GTU when planning a path

NetworkException - in case of a problem with the network, e.g., unreachability of a certain point

getId

public final String getId()

Specified by:

getId in interface GTU

Returns:

the id of the GTU

getGTUType

public GTUType getGTUType()

Specified by:

getGTUType in interface GTU

Returns:

the type of GTU, e.g. TruckType, CarType, BusType.

getReference

public final RelativePosition getReference()

Specified by:

getReference in interface GTU

Returns:

the reference position of the GTU, by definition (0, 0, 0).

getSimulator

public final OTSDEVSSimulatorInterface getSimulator()

Specified by:

getSimulator in interface GTU

Returns:

simulator the simulator to schedule plan changes on

getStrategicalPlanner

public StrategicalPlanner getStrategicalPlanner()

Specified by:

getStrategicalPlanner in interface GTU

Returns:

strategicalPlanner the planner responsible for the overall 'mission' of the GTU, usually indicating where it needs to go. It operates by instantiating tactical planners to do the work.

getTacticalPlanner

public final TacticalPlanner getTacticalPlanner()

Specified by:

getTacticalPlanner in interface GTU

Returns:

tacticalPlanner the tactical planner that can generate an operational plan

getOperationalPlan

public final OperationalPlan getOperationalPlan()

Specified by:

getOperationalPlan in interface GTU

Returns:

operationalPlan the current operational plan, which provides a short-term movement over time

getPerception

public Perception getPerception()

Specified by:

getPerception in interface GTU

Returns:

the perception module of this GTU

getOdometer

public final org.djunits.value.vdouble.scalar.Length.Rel getOdometer()

Specified by:

getOdometer in interface GTU

Returns:

Length.Rel; the current odometer value.

getVelocity

public final org.djunits.value.vdouble.scalar.Speed getVelocity(org.djunits.value.vdouble.scalar.Time.Abs time)

Specified by:

getVelocity in interface GTU

Parameters:

time - the time for which the velocity needs to be calculated.

Returns:

the acceleration of the GTU at the given time, combining longitudinal, lateral and vertical acceleration components.

getVelocity

public final org.djunits.value.vdouble.scalar.Speed getVelocity()

Specified by:

getVelocity in interface GTU

Returns:

the current velocity of the GTU, combining longitudinal, lateral and vertical speed components.

getAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration getAcceleration(org.djunits.value.vdouble.scalar.Time.Abs time)

Specified by:

getAcceleration in interface GTU

Parameters:

time - the time for which the acceleration needs to be calculated.

Returns:

the acceleration of the GTU at the given time, combining longitudinal, lateral and vertical acceleration components.

getMaximumAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration getMaximumAcceleration()

Specified by:

getMaximumAcceleration in interface GTU

Returns:

maximumAcceleration

setMaximumAcceleration

public final void setMaximumAcceleration(org.djunits.value.vdouble.scalar.Acceleration maximumAcceleration)

Parameters:

maximumAcceleration - set maximumAcceleration

getMaximumDeceleration

public final org.djunits.value.vdouble.scalar.Acceleration getMaximumDeceleration()

Specified by:

getMaximumDeceleration in interface GTU

Returns:

maximumDeceleration

setMaximumDeceleration

public final void setMaximumDeceleration(org.djunits.value.vdouble.scalar.Acceleration maximumDeceleration)

Parameters:

maximumDeceleration - set maximumDeceleration, stored as a negative number

getAcceleration

public final org.djunits.value.vdouble.scalar.Acceleration getAcceleration()

Specified by:

getAcceleration in interface GTU

Returns:

the current acceleration of the GTU, combining longitudinal, lateral and vertical acceleration components.

getLocation

public DirectedPoint getLocation()

Specified by:

getLocation in interface LocatableInterface

Specified by:

getLocation in interface GTU

getTurnIndicatorStatus

public final TurnIndicatorStatus getTurnIndicatorStatus()

Specified by:

getTurnIndicatorStatus in interface GTU

Returns:

the status of the turn indicator.

setTurnIndicatorStatus

public final void setTurnIndicatorStatus(TurnIndicatorStatus turnIndicatorStatus)
                                  throws GTUException

Set the status of the turn indicator.

Specified by:

setTurnIndicatorStatus in interface GTU

Parameters:

turnIndicatorStatus - the new status of the turn indicator.

Throws:

GTUException - when GTUType does not have a turn indicator

isDestroyed

public final boolean isDestroyed()

Returns:

whether the GTU is destroyed, for the animation.

getPerceivableContext

public final PerceivableContext getPerceivableContext()

Returns:

perceivableContext