org.opentrafficsim.road.network.lane.object

Class SpeedSign

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.object.StaticObject

org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

org.opentrafficsim.road.network.lane.object.SpeedSign

All Implemented Interfaces:

Serializable, Locatable, EventProducerInterface, Identifiable, ObjectInterface, LaneBasedObject

public class SpeedSign
extends AbstractLaneBasedObject

Speed sign.

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$, $LastChangedDate$, by $Author$, initial version 20 apr. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

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

listeners

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

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor and Description
SpeedSign(String id, Lane lane, LongitudinalDirectionality direction, Length longitudinalPosition, SimulatorInterface.TimeDoubleUnit simulator, Speed speed) Speed sign active all day for all GTU types.
SpeedSign(String id, Lane lane, LongitudinalDirectionality direction, Length longitudinalPosition, SimulatorInterface.TimeDoubleUnit simulator, Speed speed, Duration startTimeOfDay, Duration endTimeOfDay) Speed sign for all GTU types.
SpeedSign(String id, Lane lane, LongitudinalDirectionality direction, Length longitudinalPosition, SimulatorInterface.TimeDoubleUnit simulator, Speed speed, GTUType gtuType) Speed sign active all day.
SpeedSign(String id, Lane lane, LongitudinalDirectionality direction, Length longitudinalPosition, SimulatorInterface.TimeDoubleUnit simulator, Speed speed, GTUType gtuType, Duration startTimeOfDay, Duration endTimeOfDay) Construct a new SpeedSign.

Method Summary

Modifier and Type	Method and Description
AbstractLaneBasedObject	clone(CrossSectionElement newCSE, SimulatorInterface.TimeDoubleUnit newSimulator, boolean animation) Clone the LaneBasedObject for e.g., copying a network.
boolean	equals(Object obj)
Speed	getSpeed() Returns the speed.
int	hashCode()
boolean	isActive(GTUType gtuTypeIn, Duration time) Return whether this speed limit is currently active.
String	toString()

Methods inherited from class org.opentrafficsim.road.network.lane.object.AbstractLaneBasedObject

clone, getDirection, getFullId, getLane, getLocation, getLongitudinalPosition

Methods inherited from class org.opentrafficsim.core.object.StaticObject

getBounds, getGeometry, getHeight, getId

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.network.lane.object.LaneBasedObject

getBounds, makeGeometry

Methods inherited from interface org.opentrafficsim.core.object.ObjectInterface

getGeometry, getHeight

Methods inherited from interface org.opentrafficsim.base.Identifiable

getId

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

addListener, addListener, addListener, addListener, removeListener

Constructor Detail

SpeedSign

public SpeedSign(String id,
                 Lane lane,
                 LongitudinalDirectionality direction,
                 Length longitudinalPosition,
                 SimulatorInterface.TimeDoubleUnit simulator,
                 Speed speed,
                 GTUType gtuType,
                 Duration startTimeOfDay,
                 Duration endTimeOfDay)
          throws NetworkException

Construct a new SpeedSign.

Parameters:

id - String; the id of the new SpeedSign

lane - Lane on/over which the SpeedSign is positioned

direction - LongitudinalDirectionality; driving direction for which the new SpeedSign applies

longitudinalPosition - Length; the longitudinal position along the lane of the new SpeedSign

simulator - SimulatorInterface.TimeDoubleUnit; the simulator

speed - Speed; the speed limit shown by the new SpeedSign

gtuType - GTU type that should obey the speed sign

startTimeOfDay - start time-of-day

endTimeOfDay - end time-of-day

Throws:

NetworkException - when the position on the lane is out of bounds

SpeedSign

public SpeedSign(String id,
                 Lane lane,
                 LongitudinalDirectionality direction,
                 Length longitudinalPosition,
                 SimulatorInterface.TimeDoubleUnit simulator,
                 Speed speed,
                 GTUType gtuType)
          throws NetworkException

Speed sign active all day.

Parameters:

id - id

lane - lane

direction - direction

longitudinalPosition - longitudinal position

simulator - simulator

speed - speed

gtuType - GTU type

Throws:

NetworkException - when the position on the lane is out of bounds

SpeedSign

public SpeedSign(String id,
                 Lane lane,
                 LongitudinalDirectionality direction,
                 Length longitudinalPosition,
                 SimulatorInterface.TimeDoubleUnit simulator,
                 Speed speed,
                 Duration startTimeOfDay,
                 Duration endTimeOfDay)
          throws NetworkException

Speed sign for all GTU types.

Parameters:

id - id

lane - lane

direction - direction

longitudinalPosition - longitudinal position

simulator - simulator

speed - speed

startTimeOfDay - start time-of-day

endTimeOfDay - end time-of-day

Throws:

NetworkException - when the position on the lane is out of bounds

SpeedSign

public SpeedSign(String id,
                 Lane lane,
                 LongitudinalDirectionality direction,
                 Length longitudinalPosition,
                 SimulatorInterface.TimeDoubleUnit simulator,
                 Speed speed)
          throws NetworkException

Speed sign active all day for all GTU types.

Parameters:

id - id

lane - lane

direction - direction

longitudinalPosition - longitudinal position

simulator - simulator

speed - speed

Throws:

NetworkException - when the position on the lane is out of bounds

Method Detail

isActive

public final boolean isActive(GTUType gtuTypeIn,
                              Duration time)

Return whether this speed limit is currently active.

Parameters:

gtuTypeIn - GTU type

time - current time-of-day

Returns:

whether this speed limit is currently active

getSpeed

public final Speed getSpeed()

Returns the speed.

Returns:

the speed

clone

public final AbstractLaneBasedObject clone(CrossSectionElement newCSE,
                                           SimulatorInterface.TimeDoubleUnit newSimulator,
                                           boolean animation)
                                    throws NetworkException

Clone the LaneBasedObject for e.g., copying a network.

Specified by:

clone in class AbstractLaneBasedObject

Parameters:

newCSE - CrossSectionElement; the new cross section element to which the clone belongs

newSimulator - SimulatorInterface.TimeDoubleUnit; the new simulator for this network

animation - boolean; whether to (re)create animation or not

Returns:

AbstractLaneBasedObject; a clone of this object

Throws:

NetworkException - in case the cloning fails

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class AbstractLaneBasedObject