ReceivingFlowData (planit-all 0.3.0 API)

java.lang.Object
- org.goplanit.assignment.ltm.sltm.LinkSegmentData
- - org.goplanit.assignment.ltm.sltm.loading.ReceivingFlowData

```
public class ReceivingFlowData
extends LinkSegmentData
```
POJO to store the sLTM variables used for receiving flow updates (Step 4) in network loading

Author:

markr

Constructor Summary

Constructors
Constructor Description

ReceivingFlowData(double[] emptySegmentArray)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double[]`	`getCurrentReceivingFlows()`	collect current receiving flows
`double[]`	`getNextReceivingFlows()`	collect next receiving flows
`void`	`limitNextReceivingFlowsToCapacity(MacroscopicLinkSegments linkSegments)`	Reduce all provided link segments' receiving flows to capacity in case they exceed it
`void`	`reset()`	Reset to initial state
`void`	`resetCurrentReceivingFlows()`	Reset current network segment flows
`void`	`resetNextReceivingFlows()`	Reset the segment flows for the coming iteration
`void`	`swapCurrentAndNextReceivingFlows()`	Swap the current and next receiving flows

Methods inherited from class org.goplanit.assignment.ltm.sltm.LinkSegmentData
copyTo, createinitialStateLinkSegmentDoubleArray, limitFlowsToCapacity, swap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReceivingFlowData
```
public ReceivingFlowData(double[] emptySegmentArray)
```
    Constructor
    
    Parameters:
    
    emptySegmentArray - empty array used to initialize data stores
- Method Detail
  - resetNextReceivingFlows
```
public void resetNextReceivingFlows()
```
    Reset the segment flows for the coming iteration
  - resetCurrentReceivingFlows
```
public void resetCurrentReceivingFlows()
```
    Reset current network segment flows
  - getNextReceivingFlows
```
public double[] getNextReceivingFlows()
```
    collect next receiving flows
    
    Returns:
    
    next receiving flows
  - getCurrentReceivingFlows
```
public double[] getCurrentReceivingFlows()
```
    collect current receiving flows
    
    Returns:
    
    current receiving flows
  - limitNextReceivingFlowsToCapacity
```
public void limitNextReceivingFlowsToCapacity(MacroscopicLinkSegments linkSegments)
```
    Reduce all provided link segments' receiving flows to capacity in case they exceed it
    
    Parameters:
    
    linkSegments - to use
  - swapCurrentAndNextReceivingFlows
```
public void swapCurrentAndNextReceivingFlows()
```
    Swap the current and next receiving flows
  - reset
```
public void reset()
```
    Reset to initial state