Package org.planit.project

Class PlanItProjectInput

java.lang.Object

org.planit.project.PlanItProjectInput

public class PlanItProjectInput
extends Object

Class that holds all the input traffic components for a PLANit project. The PLANit project holds an instance of this class and delegates all calls relating to inputs to this class.

Author:

markr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PlanItProjectInput.ProjectDemands	Internal class for registered demands
class	PlanItProjectInput.ProjectNetworks	Internal class for registered physical networks
class	PlanItProjectInput.ProjectODRouteSets	Internal class for registered od route sets
class	PlanItProjectInput.ProjectZonings	Internal class for registered zonings

Field Summary

Fields

Modifier and Type	Field	Description
PlanItProjectInput.ProjectDemands	demands	The registered demands
protected TrafficAssignmentComponentFactory<Demands>	demandsFactory	Object factory for demands object
protected TreeMap<Long,Demands>	demandsMap	The demands registered on this project
protected Map<PhysicalNetwork,List<InitialLinkSegmentCost>>	initialLinkSegmentCosts	Map to store all InitialLinkSegmentCost objects for each physical network
protected TrafficAssignmentComponentFactory<InitialPhysicalCost>	initialPhysicalCostFactory	Object factory for physical costs
PlanItProjectInput.ProjectODRouteSets	odRouteSets	The registered OD route sets
protected TrafficAssignmentComponentFactory<ODRouteSets>	odRouteSetsFactory	Object factory for od route sets object
protected TreeMap<Long,ODRouteSets>	odRouteSetsMap	The od route sets registered on this project
protected TrafficAssignmentComponentFactory<PhysicalNetwork>	physicalNetworkFactory	Object Factory for physical network object
protected TreeMap<Long,PhysicalNetwork>	physicalNetworkMap	The physical networks registered on this project
PlanItProjectInput.ProjectNetworks	physicalNetworks	The registered physical networks
protected TrafficAssignmentComponentFactory<Zoning>	zoningFactory	Object factory for zoning objects
PlanItProjectInput.ProjectZonings	zonings	The registered zonings
protected TreeMap<Long,Zoning>	zoningsMap	The zonings registered on this project

Constructor Summary

Constructors

Constructor	Description
PlanItProjectInput(long projectId, IdGroupingToken projectGroupId, InputBuilderListener inputBuilderListener)	Constructor

Method Summary

Modifier and Type	Method	Description
Demands	createAndRegisterDemands(Zoning zoning, PhysicalNetwork physicalNetwork)	Create and register demands to the project inputs
InitialLinkSegmentCost	createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network, String fileName)	Create and register initial link segment costs from a (single) file which we assume are available in the native xml/csv output format as provided in this project
List<InitialLinkSegmentCostPeriod>	createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network, String fileName, Demands demands)	Create and register initial link segment costs from a (single) file for all time periods in Demands object
InitialLinkSegmentCostPeriod	createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network, String fileName, TimePeriod timePeriod)	Create and register initial link segment costs from a (single) file for each time period
ODRouteSets	createAndRegisterODRouteSets(PhysicalNetwork physicalNetwork, Zoning zoning, String odRouteSetInputPath)	Create and register the OD route sets on the project input
PhysicalNetwork	createAndRegisterPhysicalNetwork(String physicalNetworkType)	Create and register a physical network on the project input
Zoning	createAndRegisterZoning(PhysicalNetwork physicalNetwork)	Create and register the zoning system on the network and project input
List<InitialLinkSegmentCost>	getInitialLinkSegmentCost(PhysicalNetwork network)	Return the initial link segment costs for a network

Methods inherited from class java.lang.Object

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

Field Detail

physicalNetworkMap

protected final TreeMap<Long,PhysicalNetwork> physicalNetworkMap

The physical networks registered on this project

demandsMap

protected final TreeMap<Long,Demands> demandsMap

The demands registered on this project

odRouteSetsMap

protected final TreeMap<Long,ODRouteSets> odRouteSetsMap

The od route sets registered on this project

zoningsMap

protected final TreeMap<Long,Zoning> zoningsMap

The zonings registered on this project

initialLinkSegmentCosts

protected final Map<PhysicalNetwork,List<InitialLinkSegmentCost>> initialLinkSegmentCosts

Map to store all InitialLinkSegmentCost objects for each physical network

physicalNetworkFactory

protected TrafficAssignmentComponentFactory<PhysicalNetwork> physicalNetworkFactory

Object Factory for physical network object

demandsFactory

protected TrafficAssignmentComponentFactory<Demands> demandsFactory

Object factory for demands object

zoningFactory

protected TrafficAssignmentComponentFactory<Zoning> zoningFactory

Object factory for zoning objects

odRouteSetsFactory

protected TrafficAssignmentComponentFactory<ODRouteSets> odRouteSetsFactory

Object factory for od route sets object

initialPhysicalCostFactory

protected TrafficAssignmentComponentFactory<InitialPhysicalCost> initialPhysicalCostFactory

Object factory for physical costs

physicalNetworks

public final PlanItProjectInput.ProjectNetworks physicalNetworks

The registered physical networks

demands

public final PlanItProjectInput.ProjectDemands demands

The registered demands

zonings

public final PlanItProjectInput.ProjectZonings zonings

The registered zonings

odRouteSets

public final PlanItProjectInput.ProjectODRouteSets odRouteSets

The registered OD route sets

Constructor Detail

PlanItProjectInput

public PlanItProjectInput(long projectId,
                          IdGroupingToken projectGroupId,
                          InputBuilderListener inputBuilderListener)

Constructor

Parameters:

projectId - the projectId

projectGroupId - the id generator token

inputBuilderListener - the input builder to parse inputs

Method Detail

createAndRegisterPhysicalNetwork

public PhysicalNetwork createAndRegisterPhysicalNetwork(String physicalNetworkType)
                                                 throws PlanItException

Create and register a physical network on the project input

Parameters:

physicalNetworkType - name of physical network class to register

Returns:

the generated physical network

Throws:

PlanItException - thrown if there is an error

createAndRegisterZoning

public Zoning createAndRegisterZoning(PhysicalNetwork physicalNetwork)
                               throws PlanItException

Create and register the zoning system on the network and project input

Parameters:

physicalNetwork - the physical network on which the zoning will be based

Returns:

the generated zoning object

Throws:

PlanItException - thrown if there is an error

createAndRegisterDemands

public Demands createAndRegisterDemands(Zoning zoning,
                                        PhysicalNetwork physicalNetwork)
                                 throws PlanItException

Create and register demands to the project inputs

Parameters:

zoning - zoning object which defines the zones which will be used in the demand matrix to be created

physicalNetwork - the physical network which stores the modes (demands can different for each mode)

Returns:

the generated demands object

Throws:

PlanItException - thrown if there is an error

createAndRegisterODRouteSets

public ODRouteSets createAndRegisterODRouteSets(PhysicalNetwork physicalNetwork,
                                                Zoning zoning,
                                                String odRouteSetInputPath)
                                         throws PlanItException

Create and register the OD route sets on the project input

Parameters:

physicalNetwork - network the routes must be compatible with

zoning - zoning to match od routes to

odRouteSetInputPath - path to collect the routes from

Returns:

od route sets that have been parsed

Throws:

PlanItException - thrown if there is an error

createAndRegisterInitialLinkSegmentCost

public InitialLinkSegmentCost createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network,
                                                                      String fileName)
                                                               throws PlanItException

Create and register initial link segment costs from a (single) file which we assume are available in the native xml/csv output format as provided in this project

Parameters:

network - physical network the InitialLinkSegmentCost object will be registered for

fileName - file containing the initial link segment cost values

Returns:

the InitialLinkSegmentCost object

Throws:

PlanItException - thrown if there is an error

createAndRegisterInitialLinkSegmentCost

public InitialLinkSegmentCostPeriod createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network,
                                                                            String fileName,
                                                                            TimePeriod timePeriod)
                                                                     throws PlanItException

Create and register initial link segment costs from a (single) file for each time period

Parameters:

network - physical network the InitialLinkSegmentCost object will be registered for

fileName - location of file containing the initial link segment cost values

timePeriod - the current time period

Returns:

the InitialLinkSegmentCost object

Throws:

PlanItException - thrown if there is an error

createAndRegisterInitialLinkSegmentCost

public List<InitialLinkSegmentCostPeriod> createAndRegisterInitialLinkSegmentCost(PhysicalNetwork network,
                                                                                  String fileName,
                                                                                  Demands demands)
                                                                           throws PlanItException

Create and register initial link segment costs from a (single) file for all time periods in Demands object

Parameters:

network - physical network the InitialLinkSegmentCost object will be registered for

fileName - location of file containing the initial link segment cost values

demands - the Demands object

Returns:

the InitialLinkSegmentCost object

Throws:

PlanItException - thrown if there is an error

getInitialLinkSegmentCost

public List<InitialLinkSegmentCost> getInitialLinkSegmentCost(PhysicalNetwork network)

Return the initial link segment costs for a network

Parameters:

network - the specified physical network

Returns:

the initial link segment costs for the specified physical network