Package org.goplanit.assignment.traditionalstatic

Class TraditionalStaticAssignmentSimulationData

java.lang.Object

org.goplanit.assignment.SimulationData

org.goplanit.assignment.traditionalstatic.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)	Constructor

Method Summary

Modifier and Type	Method	Description
double	collectTotalNetworkSegmentFlow(LinkSegment linkSegment)	Return the total flow through a link segment across all modes
double[]	collectTotalNetworkSegmentFlows()	determine the total flow across all link segments across all modes
double[]	getModalLinkSegmentCosts(Mode mode)	Retrieve the link segment costs for a specified mode
Map<Mode,ModeData>	getModeSpecificData()	Collect the data per mode for all modes
OdPathMatrix	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
void	resetPathMatrix(Mode mode, OdZones zones)	Reset the path matrix to empty for a specified mode for all activated
void	resetSkimMatrix(Mode mode, OdZones zones, OdOutputTypeConfiguration originDestinationOutputTypeConfiguration)	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

Methods inherited from class org.goplanit.assignment.SimulationData

getIterationIndex, incrementIterationIndex, reset, setIterationIndex, shallowClone

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)

Constructor

Parameters:

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

Method Detail

getModeSpecificData

public Map<Mode,ModeData> getModeSpecificData()

Collect the data per mode for all modes

Returns:

mode specific data map

collectTotalNetworkSegmentFlow

public double collectTotalNetworkSegmentFlow(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

collectTotalNetworkSegmentFlows

public double[] collectTotalNetworkSegmentFlows()

determine the total flow across all link segments across all modes

Returns:

the total flows per link segment, null if no mode flows are available

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,
                            OdZones zones,
                            OdOutputTypeConfiguration originDestinationOutputTypeConfiguration)

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

originDestinationOutputTypeConfiguration - configuration to use

resetPathMatrix

public void resetPathMatrix(Mode mode,
                            OdZones 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 OdPathMatrix 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