Package org.opentrafficsim.water.network

Class Waterway

java.lang.Object

org.djutils.event.EventProducer

org.opentrafficsim.core.network.OTSLink

org.opentrafficsim.water.network.Waterway

All Implemented Interfaces:

Serializable, Locatable, EventProducerInterface, Identifiable, Drawable, Link

public class Waterway
extends OTSLink

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

Copyright (c) 2013-2020 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 org.djutils.event.EventProducer

eventProducerImpl

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

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

GTU_ADD_EVENT, GTU_REMOVE_EVENT

Constructor Summary

Constructors

Constructor	Description
Waterway(OTSNetwork network, String id, String name, OTSNode startNode, OTSNode endNode, LinkType linkType, OTSLine3D designLine, OTSSimulatorInterface simulator)	Construct a new waterway.

Method Summary

Modifier and Type	Method	Description
String	getName()

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

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

Methods inherited from class org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

Waterway

public Waterway(OTSNetwork network,
                String id,
                String name,
                OTSNode startNode,
                OTSNode endNode,
                LinkType linkType,
                OTSLine3D designLine,
                OTSSimulatorInterface simulator)
         throws NetworkException

Construct a new waterway.

Parameters:

network - OTSNetwork; the network.

id - String; the waterway id

name - String; the name

startNode - OTSNode; start node (directional)

endNode - OTSNode; end node (directional)

linkType - LinkType; Link type to indicate compatibility with GTU types

designLine - OTSLine3D; the OTSLine3D design line of the Link

simulator - OTSSimulatorInterface; the simulator to schedule events on

Throws:

NetworkException - when waterway with this id already exists

Method Detail

getName

public final String getName()

Returns:

name