Package org.opentrafficsim.water.demand
Class TransportDemand
java.lang.Object
org.opentrafficsim.water.demand.TransportDemand
- All Implemented Interfaces:
 java.io.Serializable
public class TransportDemand
extends java.lang.Object
implements java.io.Serializable
Demand the between terminals in an operating area (region) and other terminals.
 
 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
 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description classTransportDemand.DemandCellA cell of demand from a terminal to a terminal. - 
Constructor Summary
Constructors Constructor Description TransportDemand(DEVSSimulatorInterface.TimeDoubleUnit simulator, Region operatingArea) - 
Method Summary
Modifier and Type Method Description voidaddDemand(TransportDemand.DemandCell demandCell)add a cell to the demandmap.voidaddDemand(Terminal terminalFrom, Terminal terminalTo, int numberAnnual, double fraction20ft, double fractionEmpty, java.util.Map<Company,java.lang.Double> fractionOwners)add a cell to the demandmap.TransportDemand.DemandCellgetDemand(Terminal terminalFrom, Terminal terminalTo)java.util.Map<Terminal,java.util.Map<Terminal,TransportDemand.DemandCell>>getDemandMap()java.util.Map<Terminal,TransportDemand.DemandCell>getDemandMapFrom(Terminal terminalFrom)java.util.Map<Terminal,TransportDemand.DemandCell>getDemandMapTo(Terminal terminalTo)java.util.Set<TransportDemand.DemandCell>getDemandSetFrom(Terminal terminalFrom)java.util.Set<TransportDemand.DemandCell>getDemandSetTo(Terminal terminalTo)RegiongetOperatingArea()DEVSSimulatorInterface.TimeDoubleUnitgetSimulator() 
- 
Constructor Details
- 
TransportDemand
- Parameters:
 simulator- DEVSSimulatorInterface.TimeDoubleUnit; the simulator for scheduling the demandoperatingArea- Region; the region for which this demand holds
 
 - 
 - 
Method Details
- 
getOperatingArea
- Returns:
 - the operatingArea
 
 - 
getDemandMap
public final java.util.Map<Terminal,java.util.Map<Terminal,TransportDemand.DemandCell>> getDemandMap()- Returns:
 - the demandCells
 
 - 
addDemand
add a cell to the demandmap.- Parameters:
 demandCell- DemandCell; the cell to add
 - 
addDemand
public final void addDemand(Terminal terminalFrom, Terminal terminalTo, int numberAnnual, double fraction20ft, double fractionEmpty, java.util.Map<Company,java.lang.Double> fractionOwners)add a cell to the demandmap.- Parameters:
 terminalFrom- Terminal; origin terminalterminalTo- Terminal; destination terminalnumberAnnual- int; annual number of containers per yearfraction20ft- double; fraction of 20 ft containers (rest is 40 ft)fractionEmpty- double; fraction of empty containers (rest is full)fractionOwners- Map<Company,Double>; map of owners with fraction (adding up to 1.0) indicating who owns the containers
 - 
getDemand
- Parameters:
 terminalFrom- Terminal; origin terminalterminalTo- Terminal; destination terminal- Returns:
 - the demand between two terminals.
 
 - 
getDemandMapFrom
public final java.util.Map<Terminal,TransportDemand.DemandCell> getDemandMapFrom(Terminal terminalFrom)- Parameters:
 terminalFrom- Terminal; origin terminal- Returns:
 - the map of demands originating at a terminal.
 
 - 
getDemandMapTo
public final java.util.Map<Terminal,TransportDemand.DemandCell> getDemandMapTo(Terminal terminalTo)- Parameters:
 terminalTo- Terminal; destination terminal- Returns:
 - the map of demands for a destination terminal.
 
 - 
getDemandSetFrom
- Parameters:
 terminalFrom- Terminal; origin terminal- Returns:
 - the demands originating at a terminal as a set.
 
 - 
getDemandSetTo
- Parameters:
 terminalTo- Terminal; destination terminal- Returns:
 - the demands for a destination terminal as a set.
 
 - 
getSimulator
- Returns:
 - the simulator
 
 
 -