Package org.planit.trafficassignment.builder

Class CapacityConstrainedTrafficAssignmentBuilder

java.lang.Object

org.planit.trafficassignment.builder.TrafficAssignmentBuilder

org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder

Direct Known Subclasses:

DynamicTrafficAssignmentBuilder

public class CapacityConstrainedTrafficAssignmentBuilder
extends TrafficAssignmentBuilder

When capacity constraints are in place we make a distinction between inflow and outflow and we assume the difference between the two is governed by a fundamental diagram.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected TrafficAssignmentComponentFactory<FundamentalDiagram>	fundamentalDiagramFactory	fundamental diagram factory to create fundamental diagrams used to populate the link model
protected TrafficAssignmentComponentFactory<NodeModel>	nodeModelFactory	fundamental diagram factory to create fundamental diagrams used to populate the link model

Fields inherited from class org.planit.trafficassignment.builder.TrafficAssignmentBuilder

parentAssignment, physicalCostFactory, smoothingFactory, virtualCostFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CapacityConstrainedTrafficAssignmentBuilder(CapacityConstrainedAssignment capacityConstrainedAssignment, InputBuilderListener trafficComponentCreateListener, Demands demands, Zoning zoning, PhysicalNetwork physicalNetwork)	Constructor

Method Summary

Modifier and Type	Method	Description
FundamentalDiagram	createAndRegisterFundamentalDiagram(String fundamentalDiagramType, PhysicalNetwork physicalNetwork)	Create and register FundamentalDiagram on assignment
NodeModel	createAndRegisterNodeModel(String nodeModelType)	Create and register NodeMode on assignment

Methods inherited from class org.planit.trafficassignment.builder.TrafficAssignmentBuilder

activateOutput, createAndRegisterPhysicalCost, createAndRegisterSmoothing, createAndRegisterVirtualCost, createGapFunction, deactivateOutput, getGapFunction, getOutputConfiguration, getOutputFormatters, getPhysicalCost, getSmoothing, getVirtualCost, initialiseDefaults, isOutputTypeActive, registerInitialLinkSegmentCost, registerInitialLinkSegmentCost, registerInitialLinkSegmentCost, registerOutputFormatter, unregisterOutputFormatter

Methods inherited from class java.lang.Object

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

Field Detail

fundamentalDiagramFactory

protected final TrafficAssignmentComponentFactory<FundamentalDiagram> fundamentalDiagramFactory

fundamental diagram factory to create fundamental diagrams used to populate the link model

nodeModelFactory

protected final TrafficAssignmentComponentFactory<NodeModel> nodeModelFactory

fundamental diagram factory to create fundamental diagrams used to populate the link model

Constructor Detail

CapacityConstrainedTrafficAssignmentBuilder

protected CapacityConstrainedTrafficAssignmentBuilder(CapacityConstrainedAssignment capacityConstrainedAssignment,
                                                      InputBuilderListener trafficComponentCreateListener,
                                                      Demands demands,
                                                      Zoning zoning,
                                                      PhysicalNetwork physicalNetwork)
                                               throws PlanItException

Constructor

Parameters:

capacityConstrainedAssignment - CapacityConstrainedAssignment object to be built

trafficComponentCreateListener - the listener to be registered for any traffic components being created by this class

demands - the demands

zoning - the zoning

physicalNetwork - the physical network

Throws:

PlanItException - thrown if there is an error

Method Detail

createAndRegisterFundamentalDiagram

public FundamentalDiagram createAndRegisterFundamentalDiagram(String fundamentalDiagramType,
                                                              PhysicalNetwork physicalNetwork)
                                                       throws PlanItException

Create and register FundamentalDiagram on assignment

Parameters:

fundamentalDiagramType - the type of Fundamental Diagrams to be created

physicalNetwork - the network for which link segments the fundamental diagram parameters are to be provided

Returns:

FundamentalDiagram created

Throws:

PlanItException - thrown if there is an error

createAndRegisterNodeModel

public NodeModel createAndRegisterNodeModel(String nodeModelType)
                                     throws PlanItException

Create and register NodeMode on assignment

Parameters:

nodeModelType - the type of Node Model to be built

Returns:

NodeModel created

Throws:

PlanItException - thrown if there is an error