org.opentrafficsim.water.network.infra

Class Lock

java.lang.Object

org.opentrafficsim.water.AbstractLocated

org.opentrafficsim.water.AbstractNamedLocated

org.opentrafficsim.water.network.infra.Obstacle

org.opentrafficsim.water.network.infra.Lock

All Implemented Interfaces:

Serializable, Locatable, Dynamic, Located, Named, OperatedObstacle, Operated

public class Lock
extends Obstacle
implements OperatedObstacle

Copyright (c) 2013 Rijkswaterstaat - Dienst Water, Verkeer en Leefomgeving. All rights reserved.
Some parts of the software (c) 2011-2013 TU Delft, Faculty of TBM, Systems and Simulation
This software is licensed without restrictions to Nederlandse Organisatie voor Toegepast Natuurwetenschappelijk Onderzoek TNO (TNO), Erasmus University Rotterdam, Delft University of Technology, Panteia B.V., Stichting Projecten Binnenvaart, Ab Ovo Nederland B.V., Modality Software Solutions B.V., and Rijkswaterstaat - Dienst Water, Verkeer en Leefomgeving, including the right to sub-license sources and derived products to third parties.

Version:

Sep 28, 2012

Author:

Alexander Verbraeck

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Lock(DEVSSimulatorInterface.TimeDoubleUnit simulator, String name, WaterwayLocation waterwayLocation, int numberChambers, int operationHoursPerDay, int operationDaysPerWeek, Length length, Length width, boolean cargoPriority)

Method Summary

Modifier and Type	Method and Description
Duration	drawLockageDelay()
Duration	estimateLockageDelay()
Length	getLength()
int	getNumberChambers()
int	getOperationDaysPerWeek()
int	getOperationHoursPerDay()
DEVSSimulatorInterface.TimeDoubleUnit	getSimulator()
Length	getWidth()
boolean	isCargoPriority()
String	toString()

Methods inherited from class org.opentrafficsim.water.network.infra.Obstacle

getWaterwayLocation

Methods inherited from class org.opentrafficsim.water.AbstractNamedLocated

getName

Methods inherited from class org.opentrafficsim.water.AbstractLocated

getBounds, getLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.water.Located

getCoordinate, getOTSPoint3D, getPoint3d

Constructor Detail

Lock

public Lock(DEVSSimulatorInterface.TimeDoubleUnit simulator,
            String name,
            WaterwayLocation waterwayLocation,
            int numberChambers,
            int operationHoursPerDay,
            int operationDaysPerWeek,
            Length length,
            Length width,
            boolean cargoPriority)

Parameters:

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator to schedule on

name - String; the name of the lock

waterwayLocation - WaterwayLocation; the location along the waterway

numberChambers - int; the number of lock chambers

operationHoursPerDay - int; hours per day

operationDaysPerWeek - int; days per week

length - Length; the length

width - Length; the width

cargoPriority - boolean; does cargo have priority?

Method Detail

estimateLockageDelay

public final Duration estimateLockageDelay()

Returns:

the estimated lockage delay in hours during normal opening time

drawLockageDelay

public final Duration drawLockageDelay()

Returns:

the lockage delay in hours during normal opening time

getOperationHoursPerDay

public final int getOperationHoursPerDay()

Specified by:

getOperationHoursPerDay in interface Operated

Returns:

hours per day

getOperationDaysPerWeek

public final int getOperationDaysPerWeek()

Specified by:

getOperationDaysPerWeek in interface Operated

Returns:

days per week

getLength

public final Length getLength()

Returns:

the length

getWidth

public final Length getWidth()

Returns:

the width

getNumberChambers

public final int getNumberChambers()

Returns:

numberChambers

isCargoPriority

public final boolean isCargoPriority()

Returns:

the cargoPriority

getSimulator

public final DEVSSimulatorInterface.TimeDoubleUnit getSimulator()

Specified by:

getSimulator in interface Dynamic

Returns:

the simulator we can schedule stuff on

toString

public String toString()

Overrides:

toString in class Object