Serialized Form (Open Traffic Sim waterway classes 0.15.00 API)

Package org.opentrafficsim.water
- Class org.opentrafficsim.water.AbstractLocated extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - location
```
nl.tudelft.simulation.language.d3.DirectedPoint location
```
      coordinate on the map.
- Class org.opentrafficsim.water.AbstractLocatedEventProducer extends nl.tudelft.simulation.event.EventProducer implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - coordinate
```
com.vividsolutions.jts.geom.Coordinate coordinate
```
      coordinate on the map.
- Class org.opentrafficsim.water.AbstractNamed extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      name.
- Class org.opentrafficsim.water.AbstractNamedEventProducer extends nl.tudelft.simulation.event.EventProducer implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      the name.
- Class org.opentrafficsim.water.AbstractNamedLocated extends AbstractLocated implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      name.
- Class org.opentrafficsim.water.AbstractNamedLocatedEventProducer extends AbstractLocatedEventProducer implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      name.
- Class org.opentrafficsim.water.RepeatableRandomStream extends nl.tudelft.simulation.jstats.streams.Java2Random implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.opentrafficsim.water.SchedulableMethod extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - target
```
Object target
```
      target reflects the target on which a state change is scheduled.
    - method
```
String method
```
      method is the method which embodies the state change.
    - args
```
Object[] args
```
      args are the arguments which are used to invoke the method with.
Package org.opentrafficsim.water.demand
- Class org.opentrafficsim.water.demand.Container extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
      the simulator.
    - terminalFrom
```
Terminal terminalFrom
```
      origin terminal.
    - terminalTo
```
Terminal terminalTo
```
      destination terminal.
    - terminalLastStacked
```
Terminal terminalLastStacked
```
      terminal where the container was stacked last.
    - empty
```
boolean empty
```
      empty?
    - shippingLine
```
ShippingLine shippingLine
```
      shipping line.
    - creationTime
```
org.djunits.value.vdouble.scalar.Time creationTime
```
      creation time of container.
    - stackArrivalTime
```
org.djunits.value.vdouble.scalar.Time stackArrivalTime
```
      time of arrival at last terminal in the stack (for statistics about terminal staying time).
    - onShipTime
```
org.djunits.value.vdouble.scalar.Time onShipTime
```
      time when container loaded on ship.
    - transportCosts
```
float[] transportCosts
```
      cost breakdown (based on actual costs) of ALL handling of the container (could be multiple services).
    - transportFee
```
float[] transportFee
```
      fee breakdown (based on fixed costs for actions) of ALL handling of the container.
    - transportKgCO2
```
float[] transportKgCO2
```
      co2 breakdown (in si unit) for ALL handling of the container (could be multiple services).
    - transportTime
```
float[] transportTime
```
      time breakdown (in si unit) for ALL handling of the container (could be multiple services).
- Class org.opentrafficsim.water.demand.OtherDemand extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
      the simulator to schedule on.
    - otherDemandSet
```
Set<E> otherDemandSet
```
      the demand from and to locations.
- Class org.opentrafficsim.water.demand.PartialLoad extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - terminalFrom
```
Terminal terminalFrom
```
      origin terminal.
    - terminalTo
```
Terminal terminalTo
```
      destination terminal.
    - number
```
int number
```
      number of containers.
    - twentyFt
```
boolean twentyFt
```
      20 ft?
    - empty
```
boolean empty
```
      empty?
    - owner
```
Company owner
```
      who owns the container.
- Class org.opentrafficsim.water.demand.Region extends AbstractNamed implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - superRegion
```
Region superRegion
```
      the region to whic this region belongs, e.g. Municipality - Province - Country.
    - inhabitants
```
double inhabitants
```
      the number of inhabitants in the region.
    - jobs
```
double jobs
```
      the number of jobs in the region.
    - center
```
com.vividsolutions.jts.geom.Coordinate center
```
      the center of the region.
    - area
```
com.vividsolutions.jts.geom.MultiPolygon area
```
      the shape of this region.
    - exportTonTEU
```
double exportTonTEU
```
      export ton/teu factor.
    - importTonTEU
```
double importTonTEU
```
      import ton/teu factor.
    - exportEmptyFactor
```
double exportEmptyFactor
```
      export empty factor.
    - importEmptyFactor
```
double importEmptyFactor
```
      import empty factor.
    - currentImportTEUperYear
```
double currentImportTEUperYear
```
      current Import TEU per year.
    - currentExportTEUperYear
```
double currentExportTEUperYear
```
      current Export TEU per year.
- Class org.opentrafficsim.water.demand.TransportDemand extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
      the simulator to schedule on.
    - operatingArea
```
Region operatingArea
```
      the operating area for the demand.
    - demandMap
```
Map<K,V> demandMap
```
      the demand from and to terminals.
Package org.opentrafficsim.water.network
- Class org.opentrafficsim.water.network.StudyArea extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
      code to identify the study area
    - terminals
```
List<E> terminals
```
      the terminals in / for this sailing area
- Class org.opentrafficsim.water.network.Waterway extends org.opentrafficsim.core.network.OTSLink implements Serializable
  
  serialVersionUID:
  
  20150927L
  - Serialized Fields
    - name
```
String name
```
      name.
    - current
```
double current
```
      current; positive direction is along the design line.
    - obstacles
```
SortedMap<K,V> obstacles
```
      list of obstacles, sorted on distance along the design line.
    - terminals
```
SortedMap<K,V> terminals
```
      list of terminals, sorted on distance along the design line.
- Class org.opentrafficsim.water.network.WaterwayLocation extends Object implements Serializable
  
  serialVersionUID:
  
  20161106L
  - Serialized Fields
    - waterway
```
Waterway waterway
```
      the waterway.
    - position
```
org.djunits.value.vdouble.scalar.Length position
```
      position along the waterway, in the direction of the design line.
    - location
```
nl.tudelft.simulation.language.d3.DirectedPoint location
```
      cached location.
Package org.opentrafficsim.water.network.infra
- Class org.opentrafficsim.water.network.infra.FixedBridge extends Obstacle implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - maxHeight
```
org.djunits.value.vdouble.scalar.Length maxHeight
```
      max height in meters above surface.
- Class org.opentrafficsim.water.network.infra.Lock extends Obstacle implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
      the simulator to schedule on.
    - operationHoursPerDay
```
int operationHoursPerDay
```
      hours per day.
    - operationDaysPerWeek
```
int operationDaysPerWeek
```
      days per week.
    - length
```
org.djunits.value.vdouble.scalar.Length length
```
      length.
    - width
```
org.djunits.value.vdouble.scalar.Length width
```
      width.
    - numberChambers
```
int numberChambers
```
      number of lock chambers.
    - cargoPriority
```
boolean cargoPriority
```
      priority for cargo?
    - estimatedAverageLockageTime
```
org.djunits.value.vdouble.scalar.Duration estimatedAverageLockageTime
```
      estimated average opening time.
- Class org.opentrafficsim.water.network.infra.MovableBridge extends FixedBridge implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
      the simulator to schedule on.
    - operationHoursPerDay
```
int operationHoursPerDay
```
      hours per day.
    - operationDaysPerWeek
```
int operationDaysPerWeek
```
      days per week.
    - maxHeightClosed
```
org.djunits.value.vdouble.scalar.Length maxHeightClosed
```
      max height when bridge is closed.
    - maxHeightOpened
```
org.djunits.value.vdouble.scalar.Length maxHeightOpened
```
      max height when bridge is opened.
    - waitingTime
```
org.djunits.value.vdouble.scalar.Duration waitingTime
```
      average waiting time.
- Class org.opentrafficsim.water.network.infra.Obstacle extends AbstractNamedLocated implements Serializable
  
  serialVersionUID:
  
  20161105L
  - Serialized Fields
    - waterwayLocation
```
WaterwayLocation waterwayLocation
```
      the waterway along which it is located, and the location on the waterway.
Package org.opentrafficsim.water.role
- Class org.opentrafficsim.water.role.Company extends AbstractNamedLocated implements Serializable
  - Serialized Fields
    - code
```
String code
```
      code for the company.
- Class org.opentrafficsim.water.role.ShippingLine extends Company implements Serializable
Package org.opentrafficsim.water.statistics
- Class org.opentrafficsim.water.statistics.XCounter extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - count
```
long count
```
      count represents the value of the counter
    - n
```
long n
```
      n represents the number of measurements
    - description
```
String description
```
      description refers to the title of this counter
    - semaphore
```
Object semaphore
```
      the semaphore
- Class org.opentrafficsim.water.statistics.XFrequency extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - frequency
```
SortedMap<K,V> frequency
```
      count represents the values of the counters
    - n
```
long n
```
      n represents the number of measurements
    - description
```
String description
```
      description refers to the title of this counter
    - semaphore
```
Object semaphore
```
      the semaphore
- Class org.opentrafficsim.water.statistics.XPersistent extends XTally implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
    - startTime
```
double startTime
```
      startTime defines the time of the first event
    - elapsedTime
```
double elapsedTime
```
      elapsedTime tracks the elapsed time
    - lastValue
```
double lastValue
```
      lastvalue tracks the last value
- Class org.opentrafficsim.water.statistics.XTally extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - sum
```
double sum
```
      sum refers to the sum of the tally
    - min
```
double min
```
      min refers to the min of the tally
    - max
```
double max
```
      maxrefers to the max of the tally
    - varianceSum
```
double varianceSum
```
      varianceSum refers to the varianceSum of the tally
    - n
```
long n
```
      n refers to the number of measurements
    - description
```
String description
```
      description refers to the description of this tally
    - confidenceDistribution
```
nl.tudelft.simulation.jstats.distributions.DistNormal confidenceDistribution
```
      the confidenceDistribution
    - semaphore
```
Object semaphore
```
      the semaphore
- Class org.opentrafficsim.water.statistics.XTimeTally extends XTally implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - simulator
```
org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator
```
Package org.opentrafficsim.water.transfer
- Class org.opentrafficsim.water.transfer.Terminal extends AbstractNamedLocated implements Serializable

Serialized Form

Package org.opentrafficsim.water

Class org.opentrafficsim.water.AbstractLocated extends Object implements Serializable

Serialized Fields

location

Class org.opentrafficsim.water.AbstractLocatedEventProducer extends nl.tudelft.simulation.event.EventProducer implements Serializable

Serialized Fields

coordinate

Class org.opentrafficsim.water.AbstractNamed extends Object implements Serializable

Serialized Fields

name

Class org.opentrafficsim.water.AbstractNamedEventProducer extends nl.tudelft.simulation.event.EventProducer implements Serializable

Serialized Fields

name

Class org.opentrafficsim.water.AbstractNamedLocated extends AbstractLocated implements Serializable

Serialized Fields

name

Class org.opentrafficsim.water.AbstractNamedLocatedEventProducer extends AbstractLocatedEventProducer implements Serializable

Serialized Fields

name

Class org.opentrafficsim.water.RepeatableRandomStream extends nl.tudelft.simulation.jstats.streams.Java2Random implements Serializable

Class org.opentrafficsim.water.SchedulableMethod extends Object implements Serializable

Serialized Fields

target

method

args

Package org.opentrafficsim.water.demand

Class org.opentrafficsim.water.demand.Container extends Object implements Serializable

Serialized Fields

simulator

terminalFrom

terminalTo

terminalLastStacked

empty

shippingLine

creationTime

stackArrivalTime

onShipTime

transportCosts

transportFee

transportKgCO2

transportTime

Class org.opentrafficsim.water.demand.OtherDemand extends Object implements Serializable

Serialized Fields

simulator

otherDemandSet

Class org.opentrafficsim.water.demand.PartialLoad extends Object implements Serializable

Serialized Fields

terminalFrom

terminalTo

number

twentyFt

empty

owner

Class org.opentrafficsim.water.demand.Region extends AbstractNamed implements Serializable

Serialized Fields

superRegion

inhabitants

jobs

center

area

exportTonTEU

importTonTEU

exportEmptyFactor

importEmptyFactor

currentImportTEUperYear

currentExportTEUperYear

Class org.opentrafficsim.water.demand.TransportDemand extends Object implements Serializable

Serialized Fields

simulator

operatingArea

demandMap

Package org.opentrafficsim.water.network

Class org.opentrafficsim.water.network.StudyArea extends Object implements Serializable

Serialized Fields

code

terminals

Class org.opentrafficsim.water.network.Waterway extends org.opentrafficsim.core.network.OTSLink implements Serializable

Serialized Fields

name