SendingFlowData (PLANitAllJavaOnly 0.4.0 API)

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

```
public class SendingFlowData
extends LinkSegmentData
```
POJO to store the sLTM variables used for sending flow updates (Step 2) in network loading

Author:

markr

Constructor Summary

Constructors
Constructor Description

SendingFlowData(double[] emptySegmentArray)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double[]`	`getCurrentSendingFlows()`	collect current sending flows
`double[]`	`getNextSendingFlows()`	collect next sending flows
`void`	`limitCurrentSendingFlowsToCapacity(MacroscopicLinkSegments linkSegments)`	Reduce all current link segments' sending flows to capacity in case they exceed it
`void`	`reset()`	Reset all sending flows
`void`	`resetCurrentSendingFlows()`	Reset current network segment flows
`void`	`resetNextSendingFlows()`	Reset the segment flows for the coming iteration
`void`	`swapCurrentAndNextSendingFlows()`	replace current sending flows by the next sending 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
  - SendingFlowData
```
public SendingFlowData(double[] emptySegmentArray)
```
    Constructor
    
    Parameters:
    
    emptySegmentArray - empty array used to initialize data stores
- Method Detail
  - resetNextSendingFlows
```
public void resetNextSendingFlows()
```
    Reset the segment flows for the coming iteration
  - resetCurrentSendingFlows
```
public void resetCurrentSendingFlows()
```
    Reset current network segment flows
  - reset
```
public void reset()
```
    Reset all sending flows
  - getNextSendingFlows
```
public double[] getNextSendingFlows()
```
    collect next sending flows
    
    Returns:
    
    next sending flows
  - getCurrentSendingFlows
```
public double[] getCurrentSendingFlows()
```
    collect current sending flows
    
    Returns:
    
    current sending flows
  - limitCurrentSendingFlowsToCapacity
```
public void limitCurrentSendingFlowsToCapacity(MacroscopicLinkSegments linkSegments)
```
    Reduce all current link segments' sending flows to capacity in case they exceed it
    
    Parameters:
    
    linkSegments - to use
  - swapCurrentAndNextSendingFlows
```
public void swapCurrentAndNextSendingFlows()
```
    replace current sending flows by the next sending flows