org.opentrafficsim.water.demand

Class Container

java.lang.Object

org.opentrafficsim.water.demand.Container

All Implemented Interfaces:

Serializable

public class Container
extends Object
implements Serializable

A container is exactly 1 TEU. It collects statistics along the way, which are reported to the statistics objects just before the container disappears from the model at the inland client or deep sea terminal / empty depot.

Copyright (c) 2013-2017 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

Constructor Summary

Constructors

Constructor and Description
Container(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, Terminal terminalFrom, Terminal terminalTo, boolean empty, ShippingLine shippingLine)

Method Summary

Modifier and Type	Method and Description
void	addTransportCost(ContainerTransportCostBreakdownEnum costEnum, double cost)
void	addTransportFee(ContainerTransportFeeBreakdownEnum feeEnum, double fee)
void	addTransportKgCO2(ContainerTransportCO2BreakdownEnum co2Enum, double kgCO2)
void	addTransportTime(ContainerTransportTimeBreakdownEnum timeEnum, double time)
void	collectTerminalStatisticsAtContainerDestination() Collect the final statistics when the container arrived at its destination.
FullEmptyEnum	fullEmpty()
org.djunits.value.vdouble.scalar.Time	getCreationTime()
org.djunits.value.vdouble.scalar.Time	getOnShipTime()
Company	getOwner()
ShippingLine	getShippingLine()
org.djunits.value.vdouble.scalar.Time	getStackArrivalTime()
double	getSumTransportCost()
double	getSumTransportFee()
double	getSumTransportKgCO2()
double	getSumTransportTime()
Terminal	getTerminalFrom()
Terminal	getTerminalLastStacked()
Terminal	getTerminalTo()
double	getTransportCost(ContainerTransportCostBreakdownEnum costEnum)
double	getTransportFee(ContainerTransportFeeBreakdownEnum feeEnum)
double	getTransportKgCO2(ContainerTransportCO2BreakdownEnum co2Enum)
double	getTransportTime(ContainerTransportTimeBreakdownEnum timeEnum)
boolean	isEmpty()
void	setOnShipTime() set onShipTime.
void	setStackArrivalTime() set the arrivalTime.
void	setTerminalFrom(Terminal terminalFrom)
void	setTerminalLastStacked(Terminal terminalLastStacked)
void	setTerminalTo(Terminal terminalTo)
String	toShortString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                 Terminal terminalFrom,
                 Terminal terminalTo,
                 boolean empty,
                 ShippingLine shippingLine)

Parameters:

simulator - the simulator

terminalFrom - origin terminal

terminalTo - destination terminal

empty - empty or full

shippingLine - shipping line of the container

Method Detail

addTransportCost

public final void addTransportCost(ContainerTransportCostBreakdownEnum costEnum,
                                   double cost)

Parameters:

costEnum - cost category

cost - cost to add

addTransportFee

public final void addTransportFee(ContainerTransportFeeBreakdownEnum feeEnum,
                                  double fee)

Parameters:

feeEnum - cost category

fee - the fee to add

addTransportKgCO2

public final void addTransportKgCO2(ContainerTransportCO2BreakdownEnum co2Enum,
                                    double kgCO2)

Parameters:

co2Enum - CO2 category

kgCO2 - the amount of CO2 to add

addTransportTime

public final void addTransportTime(ContainerTransportTimeBreakdownEnum timeEnum,
                                   double time)

Parameters:

timeEnum - time category

time - the time in hours to add

getTransportCost

public final double getTransportCost(ContainerTransportCostBreakdownEnum costEnum)

Parameters:

costEnum - cost category

Returns:

costs of this cost breakdown category until now

getTransportFee

public final double getTransportFee(ContainerTransportFeeBreakdownEnum feeEnum)

Parameters:

feeEnum - cost category

Returns:

fee until now of this cost breakdown category until now

getTransportKgCO2

public final double getTransportKgCO2(ContainerTransportCO2BreakdownEnum co2Enum)

Parameters:

co2Enum - CO2 category

Returns:

kg CO2 of this CO2 breakdown category until now

getTransportTime

public final double getTransportTime(ContainerTransportTimeBreakdownEnum timeEnum)

Parameters:

timeEnum - time category

Returns:

the time in hours

getSumTransportCost

public final double getSumTransportCost()

Returns:

summed total costs

getSumTransportFee

public final double getSumTransportFee()

Returns:

summed total fee

getSumTransportKgCO2

public final double getSumTransportKgCO2()

Returns:

summed total kg CO2

getSumTransportTime

public final double getSumTransportTime()

Returns:

summed total time

collectTerminalStatisticsAtContainerDestination

public final void collectTerminalStatisticsAtContainerDestination()

Collect the final statistics when the container arrived at its destination.

getTerminalFrom

public final Terminal getTerminalFrom()

Returns:

the terminalFrom

getTerminalTo

public final Terminal getTerminalTo()

Returns:

the terminalTo

getTerminalLastStacked

public final Terminal getTerminalLastStacked()

Returns:

the terminalCurrent

setTerminalFrom

public final void setTerminalFrom(Terminal terminalFrom)

Parameters:

terminalFrom - the terminalFrom to set

setTerminalTo

public final void setTerminalTo(Terminal terminalTo)

Parameters:

terminalTo - the terminalTo to set

setTerminalLastStacked

public final void setTerminalLastStacked(Terminal terminalLastStacked)

Parameters:

terminalLastStacked - the terminalCurrent to set

isEmpty

public final boolean isEmpty()

Returns:

the empty

fullEmpty

public final FullEmptyEnum fullEmpty()

Returns:

full or empty

getOwner

public final Company getOwner()

Returns:

the owner

getShippingLine

public final ShippingLine getShippingLine()

Returns:

the shippingLine

toString

public final String toString()

Overrides:

toString in class Object

toShortString

public final String toShortString()

Returns:

short info

getStackArrivalTime

public final org.djunits.value.vdouble.scalar.Time getStackArrivalTime()

Returns:

the arrivalTime

setStackArrivalTime

public final void setStackArrivalTime()

set the arrivalTime.

getCreationTime

public final org.djunits.value.vdouble.scalar.Time getCreationTime()

Returns:

the creationTime

getOnShipTime

public final org.djunits.value.vdouble.scalar.Time getOnShipTime()

Returns:

the onShipTime

setOnShipTime

public final void setOnShipTime()

set onShipTime.