Package org.planit.data

Class TraditionalStaticAssignmentSimulationData

java.lang.Object

org.planit.data.SimulationData

org.planit.data.TraditionalStaticAssignmentSimulationData

public class TraditionalStaticAssignmentSimulationData
extends SimulationData

Simulation data which are specific to Traditional Static Assignment

Author:

gman6028

Constructor Summary

Constructors

Constructor	Description
TraditionalStaticAssignmentSimulationData(IdGroupingToken groupId, OutputManager outputManager)	Constructor

Method Summary

Modifier and Type	Method	Description
Set<ODSkimSubOutputType>	getActiveSkimOutputTypes()	Returns a Set of activated OD skim output types
double[]	getModalLinkSegmentCosts(Mode mode)	Retrieve the link segment costs for a specified mode
double[]	getModalNetworkSegmentFlows(Mode mode)	Get the flows for a specified mode
Map<Mode,ModeData>	getModeSpecificData()	Collect the data per mode for all modes
ODRouteMatrix	getODPathMatrix(Mode mode)	Retrieve the current OD path for a specified mode
ODSkimMatrix	getODSkimMatrix(ODSkimSubOutputType odSkimOutputType, Mode mode)	Retrieve the skim matrix for a specified mode and skim output type
Map<ODSkimSubOutputType,ODSkimMatrix>	getSkimMatrixMap(Mode mode)	Retrieve the Map of OD Skim matrices for all active OD Skim Output Types for a specified mode
double	getTotalNetworkSegmentFlow(LinkSegment linkSegment)	Return the total flow through a link segment across all modes
void	resetModalNetworkSegmentFlows(Mode mode, int numberOfNetworkSegments)	Reset modal network segment flows by cloning empty array
void	resetPathMatrix(Mode mode, Zoning.Zones zones)	Reset the path matrix to empty for a specified mode for all activated
void	resetSkimMatrix(Mode mode, Zoning.Zones zones)	Reset the skim matrix to all zeroes for a specified mode for all activated skim output types
void	setModalLinkSegmentCosts(Mode mode, double[] modalLinkSegmentCosts)	Set the link segment costs for a specified mode
void	setModalNetworkSegmentFlows(Mode mode, double[] modalNetworkSegmentFlows)	Set the flows for a specified mode

Methods inherited from class org.planit.data.SimulationData

getIterationIndex, incrementIterationIndex, setIterationIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

TraditionalStaticAssignmentSimulationData

public TraditionalStaticAssignmentSimulationData(IdGroupingToken groupId,
                                                 OutputManager outputManager)
                                          throws PlanItException

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

outputManager - the OutputConfiguration

Throws:

PlanItException - thrown if there is an error

Method Detail

getModalNetworkSegmentFlows

public double[] getModalNetworkSegmentFlows(Mode mode)

Get the flows for a specified mode

Parameters:

mode - the specified mode

Returns:

array of flows for current mode

getModeSpecificData

public Map<Mode,ModeData> getModeSpecificData()

Collect the data per mode for all modes

Returns:

mode specific data map

getTotalNetworkSegmentFlow

public double getTotalNetworkSegmentFlow(LinkSegment linkSegment)

Return the total flow through a link segment across all modes

Parameters:

linkSegment - the specified link segment

Returns:

the total flow through this link segment

resetModalNetworkSegmentFlows

public void resetModalNetworkSegmentFlows(Mode mode,
                                          int numberOfNetworkSegments)

Reset modal network segment flows by cloning empty array

Parameters:

mode - the mode whose flows are to be reset

numberOfNetworkSegments - the number of network link segments

setModalNetworkSegmentFlows

public void setModalNetworkSegmentFlows(Mode mode,
                                        double[] modalNetworkSegmentFlows)

Set the flows for a specified mode

Parameters:

mode - the specified mode

modalNetworkSegmentFlows - array of flows for the specified mode

setModalLinkSegmentCosts

public void setModalLinkSegmentCosts(Mode mode,
                                     double[] modalLinkSegmentCosts)

Set the link segment costs for a specified mode

Parameters:

mode - the specified mode

modalLinkSegmentCosts - array of costs for the specified mode

getModalLinkSegmentCosts

public double[] getModalLinkSegmentCosts(Mode mode)

Retrieve the link segment costs for a specified mode

Parameters:

mode - the specified mode

Returns:

array of costs for the specified mode

resetSkimMatrix

public void resetSkimMatrix(Mode mode,
                            Zoning.Zones zones)

Reset the skim matrix to all zeroes for a specified mode for all activated skim output types

Parameters:

mode - the specified mode

zones - Zones object containing all the origin and destination zones

resetPathMatrix

public void resetPathMatrix(Mode mode,
                            Zoning.Zones zones)

Reset the path matrix to empty for a specified mode for all activated

Parameters:

mode - the specified mode

zones - Zones object containing all the origin and destination zones

getODSkimMatrix

public ODSkimMatrix getODSkimMatrix(ODSkimSubOutputType odSkimOutputType,
                                    Mode mode)

Retrieve the skim matrix for a specified mode and skim output type

Parameters:

odSkimOutputType - the specified Skim Output type

mode - the specified mode

Returns:

the skim matrix for the specified mode

getODPathMatrix

public ODRouteMatrix getODPathMatrix(Mode mode)

Retrieve the current OD path for a specified mode

Parameters:

mode - the specified mode

Returns:

the OD path for this mode

getSkimMatrixMap

public Map<ODSkimSubOutputType,ODSkimMatrix> getSkimMatrixMap(Mode mode)

Retrieve the Map of OD Skim matrices for all active OD Skim Output Types for a specified mode

Parameters:

mode - the specified mode

Returns:

Map of OD Skim matrices for all active OD Skim Output Types

getActiveSkimOutputTypes

public Set<ODSkimSubOutputType> getActiveSkimOutputTypes()

Returns a Set of activated OD skim output types

Returns:

Set of activated OD skim output types