org.opentrafficsim.water.network

Class Waterway

java.lang.Object

nl.tudelft.simulation.event.EventProducer

org.opentrafficsim.core.network.OTSLink

org.opentrafficsim.water.network.Waterway

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.Locatable, nl.tudelft.simulation.event.EventProducerInterface, org.opentrafficsim.core.network.Link

public class Waterway
extends org.opentrafficsim.core.network.OTSLink

A waterway, i.e. a river, canal or sailable route on a lake or sea.

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

Based on software from the IDVV project, which is Copyright (c) 2013 Rijkswaterstaat - Dienst Water, Verkeer en Leefomgeving and licensed without restrictions to Delft University of Technology, including the right to sub-license sources and derived products to third parties.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Nov 6, 2016

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

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

listeners

Fields inherited from interface org.opentrafficsim.core.network.Link

GTU_ADD_EVENT, GTU_REMOVE_EVENT

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

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor and Description
Waterway(org.opentrafficsim.core.network.Network network, String id, String name, org.opentrafficsim.core.network.OTSNode startNode, org.opentrafficsim.core.network.OTSNode endNode, org.opentrafficsim.core.network.LinkType linkType, org.opentrafficsim.core.geometry.OTSLine3D designLine, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.network.LongitudinalDirectionality directionality) Construct a new waterway.
Waterway(org.opentrafficsim.core.network.Network network, String id, String name, org.opentrafficsim.core.network.OTSNode startNode, org.opentrafficsim.core.network.OTSNode endNode, org.opentrafficsim.core.network.LinkType linkType, org.opentrafficsim.core.geometry.OTSLine3D designLine, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, Map<org.opentrafficsim.core.gtu.GTUType,org.opentrafficsim.core.network.LongitudinalDirectionality> directionalityMap) Construct a new waterway.

Method Summary

Modifier and Type	Method and Description
String	getName()

Methods inherited from class org.opentrafficsim.core.network.OTSLink

addDirectionality, addGTU, clone, equals, getBounds, getDesignLine, getDirectionality, getDirectionalityMap, getEndNode, getGTUCount, getGTUs, getId, getLength, getLinkType, getLocation, getNetwork, getSimulator, getStartNode, hashCode, removeDirectionality, removeGTU, toString

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

Constructor Detail

Waterway

public Waterway(org.opentrafficsim.core.network.Network network,
                String id,
                String name,
                org.opentrafficsim.core.network.OTSNode startNode,
                org.opentrafficsim.core.network.OTSNode endNode,
                org.opentrafficsim.core.network.LinkType linkType,
                org.opentrafficsim.core.geometry.OTSLine3D designLine,
                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                org.opentrafficsim.core.network.LongitudinalDirectionality directionality)
         throws org.opentrafficsim.core.network.NetworkException

Construct a new waterway.

Parameters:

network - the network.

id - the waterway id

name - the name

startNode - start node (directional)

endNode - end node (directional)

linkType - Link type to indicate compatibility with GTU types

designLine - the OTSLine3D design line of the Link

simulator - the simujlator to schedule events on

directionality - to indicate the general direction of the waterway (FORWARD = in the direction of the design line; BACKWARD is in the opposite direction; BOTH is a waterway that can be used in both directions; NONE is a waterway that cannot be used for sailing.

Throws:

org.opentrafficsim.core.network.NetworkException - when waterway with this id already exists

Waterway

public Waterway(org.opentrafficsim.core.network.Network network,
                String id,
                String name,
                org.opentrafficsim.core.network.OTSNode startNode,
                org.opentrafficsim.core.network.OTSNode endNode,
                org.opentrafficsim.core.network.LinkType linkType,
                org.opentrafficsim.core.geometry.OTSLine3D designLine,
                org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                Map<org.opentrafficsim.core.gtu.GTUType,org.opentrafficsim.core.network.LongitudinalDirectionality> directionalityMap)
         throws org.opentrafficsim.core.network.NetworkException

Construct a new waterway.

Parameters:

network - the network.

id - the waterway id

name - the name

startNode - start node (directional)

endNode - end node (directional)

linkType - Link type to indicate compatibility with GTU types

designLine - the OTSLine3D design line of the Link

simulator - the simujlator to schedule events on

directionalityMap - the directions for different type of ships; it might be that all or certain types of ships are only allowed to use a canal in one direction. Furthermore, the directions can limit waterways for certain classes of ships. Set the LongitudinalDirectionality to NONE for ships that are not allowed to sail this waterway.

Throws:

org.opentrafficsim.core.network.NetworkException - when waterway with this id already exists

Method Detail

getName

public final String getName()

Returns:

name