Package org.planit.trafficassignment.builder

Class DynamicTrafficAssignmentBuilder

java.lang.Object

org.planit.trafficassignment.builder.TrafficAssignmentBuilder

org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder

org.planit.trafficassignment.builder.DynamicTrafficAssignmentBuilder

All Implemented Interfaces:

RouteChoiceBuilder

Direct Known Subclasses:

ELTMTrafficAssignmentBuilder

public class DynamicTrafficAssignmentBuilder
extends CapacityConstrainedTrafficAssignmentBuilder
implements RouteChoiceBuilder

A dynamic traffic assignment builder is assumed to only support capacity constrained traffic assignment instances. It is used to build the traffic assignment instance with the proper configuration settings

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected TrafficAssignmentComponentFactory<RouteChoice>	routeChoiceFactory	the route choice factory

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

fundamentalDiagramFactory, nodeModelFactory

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

parentAssignment, physicalCostFactory, smoothingFactory, virtualCostFactory

Constructor Summary

Constructors

Constructor	Description
DynamicTrafficAssignmentBuilder(DynamicTrafficAssignment assignment, InputBuilderListener trafficComponentCreateListener, Demands demands, Zoning zoning, PhysicalNetwork physicalNetwork)	Constructor

Method Summary

Modifier and Type	Method	Description
RouteChoice	createAndRegisterRouteChoice(String routeChoiceType)	create and register the route choice one desires.
Smoothing	createAndRegisterSmoothing(String smoothingType)	Create and Register smoothing component

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

createAndRegisterFundamentalDiagram, createAndRegisterNodeModel

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

activateOutput, createAndRegisterPhysicalCost, 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

routeChoiceFactory

protected final TrafficAssignmentComponentFactory<RouteChoice> routeChoiceFactory

the route choice factory

Constructor Detail

DynamicTrafficAssignmentBuilder

public DynamicTrafficAssignmentBuilder(DynamicTrafficAssignment assignment,
                                       InputBuilderListener trafficComponentCreateListener,
                                       Demands demands,
                                       Zoning zoning,
                                       PhysicalNetwork physicalNetwork)
                                throws PlanItException

Constructor

Parameters:

assignment - the dynamic assignment

trafficComponentCreateListener - the listener for further traffic components that are created by the builder

demands - the demands

zoning - the zoning

physicalNetwork - the physical network

Throws:

PlanItException - thrown if there is an exception

Method Detail

createAndRegisterRouteChoice

public RouteChoice createAndRegisterRouteChoice(String routeChoiceType)
                                         throws PlanItException

create and register the route choice one desires.

Specified by:

createAndRegisterRouteChoice in interface RouteChoiceBuilder

Parameters:

routeChoiceType - the type of physical cost function to use

Returns:

route choice instance

Throws:

PlanItException - thrown if there is an error

createAndRegisterSmoothing

public Smoothing createAndRegisterSmoothing(String smoothingType)
                                     throws PlanItException

Create and Register smoothing component

Overrides:

createAndRegisterSmoothing in class TrafficAssignmentBuilder

Parameters:

smoothingType - the type of smoothing component to be created

Returns:

Smoothing object created

Throws:

PlanItException - thrown if there is an error