Package org.goplanit.assignment.ltm.sltm.loading

Class StaticLtmLoadingBushRooted

java.lang.Object

org.goplanit.assignment.ltm.sltm.loading.StaticLtmNetworkLoading

org.goplanit.assignment.ltm.sltm.loading.StaticLtmLoadingBushBase<RootedLabelledBush>

org.goplanit.assignment.ltm.sltm.loading.StaticLtmLoadingBushRooted

public class StaticLtmLoadingBushRooted
extends StaticLtmLoadingBushBase<RootedLabelledBush>

The rooted bush based network loading scheme for sLTM

Author:

markr

Field Summary

Fields inherited from class org.goplanit.assignment.ltm.sltm.loading.StaticLtmNetworkLoading

convergenceAnalyser, flowAcceptanceGapFunction, inFlowOutflowData, networkLoadingFactorData, prevIterationFinalSolutionScheme, receivingFlowData, receivingFlowGapFunction, sendingFlowData, sendingFlowGapFunction, settings, solutionScheme, splittingRateData

Constructor Summary

Constructors

Constructor	Description
StaticLtmLoadingBushRooted(IdGroupingToken idToken, long assignmentId, StaticLtmSettings settings)	Constructor

Method Summary

Modifier and Type	Method	Description
protected BushFlowUpdateConsumer<RootedLabelledBush>	createBushFlowUpdateConsumer(boolean updateTurnAcceptedFlows, boolean updateSendingFlows, boolean updateOutflows)	TODO: Create factory class for this

Methods inherited from class org.goplanit.assignment.ltm.sltm.loading.StaticLtmLoadingBushBase

activateEligibleSplittingRateTrackedNodes, activateNodeTrackingFor, networkLoadingLinkSegmentSendingflowOutflowUpdate, networkLoadingLinkSegmentSendingFlowUpdate, networkLoadingTurnFlowUpdate, setBushes, setPasManager

Methods inherited from class org.goplanit.assignment.ltm.sltm.loading.StaticLtmNetworkLoading

activateAllUsedNodeSplittingRates, activateNextExtension, getActivatedSolutionScheme, getCurrentFlowAcceptanceFactors, getCurrentInflowsPcuH, getCurrentOutflowsPcuH, getOdDemands, getSettings, getSplittingRateData, getSupportedMode, getTransportNetwork, getUsedNetworkLayer, initialiseInputs, isConverging, isIterativeSendingFlowUpdateActivated, isTrackAllNodeTurnFlows, performNodeModelUpdate, reset, resetIteration, stepFiveCheckNetworkLoadingConvergence, stepFourOutflowReceivingFlowUpdate, stepOneSplittingRatesUpdate, stepSixFinaliseForPersistence, stepThreeSplittingRateUpdate, stepTwoInflowSendingFlowUpdate, stepZeroIterationInitialisation, updatePotentiallyBlockingNodes, validateInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticLtmLoadingBushRooted

public StaticLtmLoadingBushRooted(IdGroupingToken idToken,
                                  long assignmentId,
                                  StaticLtmSettings settings)

Constructor

Parameters:

idToken - to use

assignmentId - to use

settings - to use

Method Detail

createBushFlowUpdateConsumer

protected BushFlowUpdateConsumer<RootedLabelledBush> createBushFlowUpdateConsumer(boolean updateTurnAcceptedFlows,
                                                                                  boolean updateSendingFlows,
                                                                                  boolean updateOutflows)

TODO: Create factory class for this

Factory method to create the right flow update consumer to use when conducting a bush based flow update. We either create one that updates turn accepted flows (and possibly also sending flows), or one that only updates (network wide) link sending flows and/or link outflows. The latter is to be used for initialisation/finalisation purposes only. The former is the one used during the iterative loading procedure.

Specified by:

createBushFlowUpdateConsumer in class StaticLtmLoadingBushBase<RootedLabelledBush>

Parameters:

updateTurnAcceptedFlows - flag indicating if the turn accepted flows are to be updated by this consumer

updateSendingFlows - flag indicating if the link sending flow are to be updated by this consumer

updateOutflows - flag indicating if the link outflows are to be updated by this consumer

Returns:

created flow update consumer