A B C D E F G H I K L M N O P Q R S T U V W X Z 
All Classes All Packages

A

AbstractPhysicalCost - Interface in org.planit.cost.physical
Interface to classify costs of physical links Physical links can be either InitialPhysicalCosts (which are read in at the start and are constant) or PhysicalCosts (which are derived from other inputs and are recalculated after each iteration).
accept(T, U, V) - Method in interface org.planit.utils.functionalinterface.TriConsumer
Performs this operation on the given arguments
accept(T, U, V, W) - Method in interface org.planit.utils.functionalinterface.QuadConsumer
Performs this operation on the given arguments
activateItemByClassName(Object, boolean) - Static method in class org.planit.utils.misc.LoggingUtils
create a string that states if item is activated or deactivated based and provide the simple class name
activateOdSkimOutputType(ODSkimSubOutputType) - Method in class org.planit.output.configuration.OriginDestinationOutputTypeConfiguration
Activate an ODSkimOutputType for this output type configuration
activateOutput(OutputType) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Method that allows one to activate specific output types for persistence on the traffic assignment instance
activateOutput(OutputType) - Method in class org.planit.trafficassignment.TrafficAssignment
Method that allows one to activate specific output types for persistence which is passed on to the output manager
activateSubOutputType(SubOutputTypeEnum) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Activate a SubOutputTypeEnum for this output type configuration
activeSubOutputTypes - Variable in class org.planit.output.configuration.OutputTypeConfiguration
Stores all active sub output types (if any).
actualSystemTravelTime - Variable in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Current system travel time as it stands
add(CumulativePoint, double) - Method in class org.planit.utils.cumulatives.PiecewiseLinearCumulativeCurve
append a new cumulative point to the curve which must be later or equal than the current latest point given the passed in timeInSecondsEpsilon
addCsvFileNamePerOutputType(OutputTypeEnum, String) - Method in class org.planit.output.formatter.CsvFileOutputFormatter
Add a new name of the CSV output file for a specified output type
addCsvFileNamePerOutputType(OutputTypeEnum, String) - Method in interface org.planit.output.formatter.CsvTextFileOutputFormatter
Add a new name of a CSV output file for a specified output type
addEdge(Edge) - Method in class org.planit.graph.VertexImpl.EdgesImpl
#Add edge, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge and its two vertices that have been registered.
addEdge(Edge) - Method in interface org.planit.utils.graph.Vertex.Edges
Add edge, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge and its two vertices that have been registered.
addEdgeSegment(EdgeSegment) - Method in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
#Add edgeSegment, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge segment vertices that have been registered.
addEdgeSegment(EdgeSegment) - Method in interface org.planit.route.Route
add an edge segment to the path by appending it
addEdgeSegment(EdgeSegment) - Method in class org.planit.route.RouteImpl
add an edge segment to the path by appending it
addEdgeSegment(EdgeSegment) - Method in interface org.planit.utils.graph.Vertex.EdgeSegments
Add edgeSegment, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge segment vertices that have been registered.
addInputProperty(String, Object) - Method in class org.planit.graph.EdgeImpl
Add a property from the original input that is not part of the readily available link members
addInputProperty(String, Object) - Method in class org.planit.graph.VertexImpl
Add a property from the original input that is not part of the readily available members
addInputProperty(String, Object) - Method in class org.planit.network.virtual.ZoneImpl
Add a property from the original input that is not part of the readily available members
addInputProperty(String, Object) - Method in interface org.planit.utils.graph.Edge
Add a property from the original input that is not part of the readily available link members
addLinkSegmentToExternalIdMap(Object, LinkSegment) - Method in class org.planit.input.InputBuilderListener
Stores a link segment by its external Id
addLinkSegmentTypeToExternalIdMap(Object, MacroscopicLinkSegmentType) - Method in class org.planit.input.InputBuilderListener
Stores a link segment type by its external Id
addMacroscopicModeProperties(Mode, MacroscopicModeProperties) - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
addModeToExternalIdMap(Object, Mode) - Method in class org.planit.input.InputBuilderListener
Stores a mode by its external Id
addNodeToExternalIdMap(Object, Node) - Method in class org.planit.input.InputBuilderListener
Stores a node by its external Id
addProperty(OutputProperty) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Add an output property to be included in the output files
addRegisteredEventTypeListeners(EventType) - Method in class org.planit.ltm.trafficassignment.ELTM
register all the known listeners for the passed in eventType on this producer for this event type
addRegisteredEventTypeListeners(EventType) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
register all the known listeners for the passed in eventType on this producer for this event type
addRegisteredEventTypeListeners(EventType) - Method in class org.planit.trafficassignment.TrafficAssignment
register all the known listeners for the passed in eventType on this producer for this event type
addTimePeriodToExternalIdMap(Object, TimePeriod) - Method in class org.planit.input.InputBuilderListener
Stores a time period by its external Id
addTo(double[], double[], int) - Static method in class org.planit.utils.arrays.ArrayOperations
Add the values of a second array element-wise to the first array
addtoStart(Object, Object[]) - Static method in class org.planit.utils.arrays.ArrayOperations
add an element to the start of the passed in array.
addTrafficAssignment(TrafficAssignment) - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
add traffic assignment
addTravelerTypeToExternalIdMap(Object, TravelerType) - Method in class org.planit.input.InputBuilderListener
Stores a traveler type by its external Id
addUserClassToExternalIdMap(Object, UserClass) - Method in class org.planit.input.InputBuilderListener
Stores a user class by its external Id
addZoneToExternalIdMap(Object, Zone) - Method in class org.planit.input.InputBuilderListener
Stores a zone by its external Id
apply(R, S, T) - Method in interface org.planit.utils.functionalinterface.TriFunction
Performs this operation on the given arguments
applySmoothing(double[], double[], int) - Method in class org.planit.sdinteraction.smoothing.MSASmoothing
#Apply smoothing based on the current step size
applySmoothing(double[], double[], int) - Method in class org.planit.sdinteraction.smoothing.Smoothing
Apply smoothing based on the current step size
applySmoothing(double, double) - Method in class org.planit.sdinteraction.smoothing.MSASmoothing
#Apply smoothing based on the current step size
applySmoothing(double, double) - Method in class org.planit.sdinteraction.smoothing.Smoothing
Apply smoothing based on the current step size
ArgumentParser - Class in org.planit.utils.args
This class parses program arguments and returns them as a map of file types and file locations.
ArgumentParser() - Constructor for class org.planit.utils.args.ArgumentParser
 
ArrayOperations - Class in org.planit.utils.arrays
General methods for updating arrays
ArrayOperations() - Constructor for class org.planit.utils.arrays.ArrayOperations
 
assignmentFactory - Variable in class org.planit.project.CustomPlanItProject
Object factory for network loading object
asSortedSetByStartTime() - Method in class org.planit.demands.Demands.TimePeriods
Returns a set of all registered time periods sorted by the start time, i.e., the way th time period is comparable

B

BaseOutputFormatter - Class in org.planit.output.formatter
Base class for all formatters of output data, i.e.
BaseOutputFormatter(IdGroupingToken) - Constructor for class org.planit.output.formatter.BaseOutputFormatter
Constructor
BaseOutputProperty - Class in org.planit.output.property
Template for output property classes which can be included in the output files.
BaseOutputProperty() - Constructor for class org.planit.output.property.BaseOutputProperty
 
BOOLEAN - org.planit.output.enums.Type
 
boundaryLocation - Variable in class org.planit.ltm.LinkSegmentBoundary
the location of this boundary on the link segment
BPR - Static variable in class org.planit.cost.physical.PhysicalCost
short hand for configuring physical cost with BPR function instance
BPRLinkTravelTimeCost - Class in org.planit.cost.physical
Well known BPR link performance function to compute travel time cost on link segment based on flow and configuration parameters.
BPRLinkTravelTimeCost(IdGroupingToken) - Constructor for class org.planit.cost.physical.BPRLinkTravelTimeCost
Constructor
BPRLinkTravelTimeCost.BPRParameters - Class in org.planit.cost.physical
Inner class to store Map of alpha and beta parameters used in BPR function for each mode
BPRParameters() - Constructor for class org.planit.cost.physical.BPRLinkTravelTimeCost.BPRParameters
Constructor
bprParametersForLinkSegmentAndMode - Variable in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Map containing the BPR parameters for link segment and mode, if these are specified in the network file (null if default values are being used)
bprParametersPerLinkSegment - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Array to store BPRParameters objects for each link segment to be used in calculateSegmentCost()

C

CALCULATED_SPEED - org.planit.output.property.OutputProperty
 
CalculatedSpeedOutputProperty - Class in org.planit.output.property
Calculate speed output property class
CalculatedSpeedOutputProperty() - Constructor for class org.planit.output.property.CalculatedSpeedOutputProperty
 
callVoidMethod(T, String, Object...) - Method in class org.planit.configurator.Configurator
Call a void method on the toConfigure class instance
canHandleMultipleIterations() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Flag to indicate whether an implementation can handle multiple iterations If this returns false, acts as though OutputConfiguration.setPersistOnlyFinalIteration() is set to true
canHandleMultipleIterations() - Method in class org.planit.output.formatter.MemoryOutputFormatter
Flag to indicate whether an implementation can handle multiple iterations If this returns false, acts as though OutputConfiguration.setPersistOnlyFinalIteration() is set to true
canHandleMultipleIterations() - Method in interface org.planit.output.formatter.OutputFormatter
Flag to indicate whether an implementation can handle multiple iterations If this returns false, acts as though OutputConfiguration.setPersistOnlyFinalIteration() is set to true
CAPACITY_PER_LANE - org.planit.output.property.OutputProperty
 
CapacityConstrainedAssignment - Class in org.planit.trafficassignment
Capacity constrained traffic assignment component
CapacityConstrainedAssignment(IdGroupingToken) - Constructor for class org.planit.trafficassignment.CapacityConstrainedAssignment
Constructor
capacityConstrainedBuilder - Variable in class org.planit.trafficassignment.CapacityConstrainedAssignment
The builder for all capacity constrained traffic assignment instances
CapacityConstrainedTrafficAssignmentBuilder - Class in org.planit.trafficassignment.builder
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.
CapacityConstrainedTrafficAssignmentBuilder(CapacityConstrainedAssignment, InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Constructor for class org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder
Constructor
capacityPerLane - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Maximum flow, i.e.
CapacityPerLaneOutputProperty - Class in org.planit.output.property
 
CapacityPerLaneOutputProperty() - Constructor for class org.planit.output.property.CapacityPerLaneOutputProperty
 
capacityScalingFactors - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelInput
the scaling factor to scale sending flows up to capacity per in link segment
centrePointGeometry - Variable in class org.planit.graph.VertexImpl
Centre point geometry which is coordinate reference system aware
centroid - Variable in class org.planit.network.virtual.ZoneImpl
Centroid of the zone
Centroid - Interface in org.planit.utils.network.virtual
A centroid is a special type of vertex representing the location of departure/arrival of traffic in a zone
CentroidImpl - Class in org.planit.network.virtual
Centroid implementation
CentroidImpl(IdGroupingToken, Zone) - Constructor for class org.planit.network.virtual.CentroidImpl
Constructor
centroidMap - Variable in class org.planit.network.virtual.VirtualNetwork
 
centroids - Variable in class org.planit.network.virtual.VirtualNetwork
internal class instance containing all centroid specific functionality
Centroids() - Constructor for class org.planit.network.virtual.VirtualNetwork.Centroids
 
checkForEmptyComponents() - Method in class org.planit.trafficassignment.TrafficAssignment
Check if any components are undefined, if so throw exception
closeLogger(Logger) - Static method in class org.planit.logging.Logging
Close the current logger
collectBuilder(InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.trafficassignment.TrafficAssignment
Each traffic assignment class can have its own builder which reveals what components need to be registered on the traffic assignment instance in order to function properly.
collectGlobalToken() - Static method in class org.planit.utils.id.IdGroupingToken
We have one default global token available for ids that are globally managed rather than within some container.
collectParameterTypes(Object...) - Method in class org.planit.configurator.Configurator
collect the parameter types of the passed in object in their original order
compareTo(BaseOutputProperty) - Method in class org.planit.output.property.BaseOutputProperty
compareTo method used to order the output columns when output is being written
compareTo(TimePeriod) - Method in class org.planit.time.TimePeriod
Compare this object with another TimePeriod object Comparison is based on start time and duration
compareTo(Edge) - Method in class org.planit.graph.EdgeImpl
compareTo(EdgeSegment) - Method in class org.planit.graph.EdgeSegmentImpl
compare based on edge segment id
compareTo(Vertex) - Method in class org.planit.graph.VertexImpl
Compare vertices by their id
compareTo(Mode) - Method in class org.planit.network.physical.ModeImpl
Compare based on id
componentSuperType - Variable in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
instance of the super component class this factory creates subclass instances for
computeAbsFlowRate(CumulativePoint) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Compute the absolute flow rate in cumulative units/h
computeAbsFlowRate(CumulativePoint) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Compute the absolute flow rate in cumulative units/h
computeCapacity() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
Return the total capacity Compute the total capacity by multiplying the capacity per lane and number of lanes
computeCapacity() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegment
Return the total link segment capacity in pcu/h
computeFreeFlowTravelTime(Mode) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
Compute the free flow travel time by mode, i.e.
computeFreeFlowTravelTime(Mode) - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegment
Compute the free flow travel time by mode, i.e.
computeGap() - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Compute the gap
computeSurfaceUnderCurve() - Method in class org.planit.utils.cumulatives.PiecewiseLinearCumulativeCurve
the total surface under this curve
Configurator<T> - Class in org.planit.configurator
This is the base class for all configuration oriented proxy classes.
Configurator() - Constructor for class org.planit.configurator.Configurator
Constructor
configure(T) - Method in class org.planit.configurator.Configurator
Configure the passed in instance with the registered method calls
Connectoid - Interface in org.planit.utils.network.virtual
the connecting component between centroid and a first physical node in the network.
connectoidId - Variable in class org.planit.network.virtual.ConnectoidImpl
unique internal identifier
ConnectoidImpl - Class in org.planit.network.virtual
connectoid connecting a zone to the physical road network, carrying two connectoid segments in one or two directions which may carry additional information for each particular direction of the connectoid.
ConnectoidImpl(IdGroupingToken, Centroid, Node, double) - Constructor for class org.planit.network.virtual.ConnectoidImpl
Constructor
ConnectoidImpl(IdGroupingToken, Centroid, Node, double, Object) - Constructor for class org.planit.network.virtual.ConnectoidImpl
Constructor
connectoidMap - Variable in class org.planit.network.virtual.VirtualNetwork
 
connectoids - Variable in class org.planit.network.virtual.VirtualNetwork
internal class instance containing all connectoid specific functionality
Connectoids() - Constructor for class org.planit.network.virtual.VirtualNetwork.Connectoids
 
ConnectoidSegment - Interface in org.planit.utils.network.virtual
Connectoid segment represents a directional virtual segment connecting a centroid and a physical node.
connectoidSegmentId - Variable in class org.planit.network.virtual.ConnectoidSegmentImpl
unique internal identifier
ConnectoidSegmentImpl - Class in org.planit.network.virtual
The link segment that connects a zone to the physical network is not a physical link segment.
ConnectoidSegmentImpl(IdGroupingToken, Connectoid, boolean) - Constructor for class org.planit.network.virtual.ConnectoidSegmentImpl
Constructor
connectoidSegmentMap - Variable in class org.planit.network.virtual.VirtualNetwork
 
connectoidSegments - Variable in class org.planit.network.virtual.VirtualNetwork
internal class instance containing all connectoid segment specific functionality
ConnectoidSegments() - Constructor for class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
 
connectVerticesToEdge(Edge) - Method in class org.planit.network.transport.TransportNetwork
Add Edge to both vertices
connectVerticesToEdgeSegment(EdgeSegment) - Method in class org.planit.network.transport.TransportNetwork
Add edge segment to the incoming or outgoing set of edge segments for the related vertices
convertArgsToMap(String[]) - Static method in class org.planit.utils.args.ArgumentParser
Convert MetroScan program arguments into a Map of file locations , with file type as key and file location as values
convertFromPlanItToXmlGeneratedType(Type) - Static method in interface org.planit.io.xml.converter.EnumConverter
Convert values from Type enumeration in PLANit project to generated Typevalues enumeration
convertFromPlanItToXmlGeneratedUnits(Units) - Static method in interface org.planit.io.xml.converter.EnumConverter
Convert values from Units enumeration in PLANit project to generated Unitsvalues enumeration
convertHoursToSeconds(double) - Static method in class org.planit.time.TimePeriod
Convert hours to (whole) seconds
convertHoursToSeconds(String) - Static method in class org.planit.time.TimePeriod
Convert duration to seconds given start time using the 24-hour clock
convertSecondsToHours(int) - Static method in class org.planit.time.TimePeriod
Convert seconds to 24h format from midnight to seconds
convertToBaseOutputProperty(String) - Static method in class org.planit.output.property.BaseOutputProperty
Generate the appropriate BaseOutputProperty object from a specified class name
convertToBaseOutputProperty(OutputProperty) - Static method in class org.planit.output.property.BaseOutputProperty
Generate the appropriate BaseOutputProperty object from a specified enumeration value
convertToDirectPositions(Coordinate[]) - Method in class org.planit.geo.PlanitGeoUtils
Convert JTS coordinates to OpenGIS directPositions
convertToOpenGisLineString(LineString) - Method in class org.planit.geo.PlanitGeoUtils
Convert a JTS line string object to an OpenGis LineString instance by transferring the internal coordinates
convertToOpenGisLineString(MultiLineString) - Method in class org.planit.geo.PlanitGeoUtils
Converts a JTS MultiLineString with a single entry into an OpenGIS LineString instance
Cost<T extends EdgeSegment> - Interface in org.planit.cost
Cost of an EdgeSegment
COST - org.planit.output.enums.ODSkimSubOutputType
 
COST_TIMES_FLOW - org.planit.output.property.OutputProperty
 
costPerModeAndLinkSegment - Variable in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Map to store initial cost for each mode and link segment
CostTimesFlowOutputProperty - Class in org.planit.output.property
Cost times flow output property class
CostTimesFlowOutputProperty() - Constructor for class org.planit.output.property.CostTimesFlowOutputProperty
 
create(String, Object[]) - Method in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
Create traffic assignment component
create(String, Object[], Object...) - Method in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
Create traffic assignment component
createAndRegisterConnectoidSegment(Connectoid, boolean) - Method in class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
Create and register connectoid segment in AB direction on virtual network
createAndRegisterDemandMatrix(Demands, List<XMLElementOdMatrix>, Zoning.Zones, InputBuilderListener) - Static method in class org.planit.io.xml.demands.DemandsPopulator
Creates a ODDemandMatrix object from a List of Odmatrix objects read in from the XML input file and registers it in the Demands object
createAndRegisterDemands(Zoning, PhysicalNetwork) - Method in class org.planit.project.CustomPlanItProject
Create and register demands to the project
createAndRegisterDemands(Zoning, PhysicalNetwork) - Method in class org.planit.project.PlanItProjectInput
Create and register demands to the project inputs
createAndRegisterFundamentalDiagram(String, PhysicalNetwork) - Method in class org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder
Create and register FundamentalDiagram on assignment
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String) - Method in class org.planit.project.CustomPlanItProject
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
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String) - Method in class org.planit.project.PlanItProjectInput
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
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String, Demands) - Method in class org.planit.project.CustomPlanItProject
Create and register initial link segment costs from a (single) file for all time periods in Demands object
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String, Demands) - Method in class org.planit.project.PlanItProjectInput
Create and register initial link segment costs from a (single) file for all time periods in Demands object
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String, TimePeriod) - Method in class org.planit.project.CustomPlanItProject
Create and register initial link segment costs from a (single) file and register it to the provided time period
createAndRegisterInitialLinkSegmentCost(PhysicalNetwork, String, TimePeriod) - Method in class org.planit.project.PlanItProjectInput
Create and register initial link segment costs from a (single) file for each time period
createAndRegisterLinkSegments(XMLElementInfrastructure, MacroscopicNetwork, Map<Long, MacroscopicLinkSegmentTypeXmlHelper>, InputBuilderListener) - Static method in class org.planit.io.xml.network.ProcessInfrastructure
Generated and register link segments
createAndRegisterLogitModel(String) - Method in class org.planit.route.choice.StochasticRouteChoice
create and register the logit model of choice
createAndRegisterModes(PhysicalNetwork, XMLElementLinkConfiguration, InputBuilderListener) - Static method in class org.planit.io.xml.network.ProcessLinkConfiguration
Reads mode types from input file and stores them in a Map
createAndRegisterNewMacroscopicLinkSegmentType(String, double, double, Object, Map<Mode, MacroscopicModeProperties>) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Create and register new macroscopic link segment type on network.
createAndRegisterNewTimePeriod(long, String, long, long) - Method in class org.planit.demands.Demands.TimePeriods
Factory method to create and register a new time period on the demands
createAndRegisterNewTravelerType(long, String) - Method in class org.planit.demands.Demands.TravelerTypes
Factory method to create and register a new travel type on the demands
createAndRegisterNewUserClass(long, String, Mode, TravelerType) - Method in class org.planit.demands.Demands.UserClasses
Factory method to create and register a new user class on the demands
createAndRegisterNewZone(Object) - Method in class org.planit.network.virtual.Zoning.Zones
Create and register new zone to network identified via its id
createAndRegisterNodeModel(String) - Method in class org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder
Create and register NodeMode on assignment
createAndRegisterNodes(XMLElementInfrastructure, MacroscopicNetwork, InputBuilderListener) - Static method in class org.planit.io.xml.network.ProcessInfrastructure
Create and register nodes on the network
createAndRegisterOdRouteMatrix(Zoning) - Method in class org.planit.route.ODRouteSets
Create an empty od route matrix and register it on this od route sets
createAndRegisterODRouteSets(PhysicalNetwork, Zoning, String) - Method in class org.planit.project.CustomPlanItProject
Create and register the OD route sets as populated by the input builder through the path source
createAndRegisterODRouteSets(PhysicalNetwork, Zoning, String) - Method in class org.planit.project.PlanItProjectInput
Create and register the OD route sets on the project input
createAndRegisterOutputFormatter(String) - Method in class org.planit.project.CustomPlanItProject
Create and register an output formatter instance of a given type
createAndRegisterOutputTypeConfiguration(OutputType, TrafficAssignment) - Method in class org.planit.output.OutputManager
Factory method to create an output configuration and adapter for a given type
createAndRegisterPhysicalCost(String) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Create and register physical link cost function to determine travel time
createAndRegisterPhysicalNetwork(String) - Method in class org.planit.project.CustomPlanItProject
Create and register a physical network on the project
createAndRegisterPhysicalNetwork(String) - Method in class org.planit.project.PlanItProjectInput
Create and register a physical network on the project input
createAndRegisterRouteChoice(String) - Method in interface org.planit.route.choice.RouteChoiceBuilder
create and register the route choice one desires.
createAndRegisterRouteChoice(String) - Method in class org.planit.trafficassignment.builder.DynamicTrafficAssignmentBuilder
create and register the route choice one desires.
createAndRegisterSmoothing(String) - Method in class org.planit.trafficassignment.builder.DynamicTrafficAssignmentBuilder
Create and Register smoothing component
createAndRegisterSmoothing(String) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Create and Register smoothing component
createAndRegisterTrafficAssignment(String) - Method in class org.planit.io.project.PlanItSimpleProject
On a simple project we only allow a single assignment to be registered.
createAndRegisterTrafficAssignment(String, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.io.project.PlanItProject
Create and register a deterministic traffic assignment instance of a given type
createAndRegisterTrafficAssignment(String, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.io.project.PlanItSimpleProject
Disallow the use of the generic create and register traffic assignment because a simple project automatically determines its demands, zoning, and network
createAndRegisterTrafficAssignment(String, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.project.CustomPlanItProject
Create and register a deterministic traffic assignment instance of a given type
createAndRegisterVirtualCost(String) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Create and Register virtual link cost function to determine travel time
createAndRegisterZoning(PhysicalNetwork) - Method in class org.planit.project.CustomPlanItProject
Create and register the zoning system on the network
createAndRegisterZoning(PhysicalNetwork) - Method in class org.planit.project.PlanItProjectInput
Create and register the zoning system on the network and project input
createDemandsPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular demands are prefixed with the exact same string, i.e.
createDirectionalLinkSegment(Link, boolean) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Create directional link segment
createGapFunction() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Currently, there exists only a single gap function (link based relative duality gap) that is created via this factory method.
createIdGeneratorForParent(IdGroupingToken) - Static method in class org.planit.utils.id.IdGenerator
Create new idGenerators for this group such that we track unique id's within this group
createIdGroupingToken(Object, long) - Static method in class org.planit.utils.id.IdGenerator
Factory method to create a new id grouping token based on the class instance simple name and the instance id This allows for a human readable token as well as a unique token
createIdGroupingToken(String) - Static method in class org.planit.utils.id.IdGenerator
Factory method to create a new id grouping token
createInstance(String, Object...) - Static method in class org.planit.utils.reflection.ReflectionUtils
Create an instance of given class name and provided constructor parameters
createIterationPrefix(int) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular traffic assignment run are prefixed with the exact same iteration string, i.e.
createLink(Node, Node, double, String) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Create a new link instance
createLink(Node, Node, double, String) - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Create a new link instance
createLinkSegment(Link, boolean) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Create a new MacroscopicLinkSegment
createLinkSegment(Link, boolean) - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Create a new physical link segment instance
createLinkSegmentType(String, double, double, Object, Map<Mode, MacroscopicModeProperties>) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Create a fully functional macroscopic link segment type instance
createLinkSegmentTypeHelperMap(XMLElementLinkConfiguration, InputBuilderListener) - Static method in class org.planit.io.xml.network.ProcessLinkConfiguration
Reads MacroscopicLinkSegmentTypeXmlHelper objects from input file and stores them in a Map
createLogger(Class<?>) - Static method in class org.planit.logging.Logging
Create logger using default values in logging properties resource file
createLogger(Class<?>, String) - Static method in class org.planit.logging.Logging
Create logger This method is unlikely to be used directly since the value of logFileSystemProperty should never be changed from its default.
createLoggingPrefix() - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
create the logging prefix for logging statements during equilibration
createLoggingPrefix(int) - Method in class org.planit.trafficassignment.TrafficAssignment
create the logging prefix for logging statements during equilibration
createMode(long, String, double) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Create a new mode
createMode(long, String, double) - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Create a new mode
createNetworkPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular network are prefixed with the exact same string, i.e.
createNode() - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Create a new node instance
createNode() - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Create a new node instance
createOdRouteSetsPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular od route sets are prefixed with the exact same string, i.e.
createOrUpdateLinkSegmentTypeHelper(String, double, double, double, double, long, Object, InputBuilderListener) - Static method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
Create or update an MacroscopicLinkSegmentTypeXmlHelper object using the input from the current row in the XML input file If the mode number is 0, all modes are updated
createOutputFormatter(String) - Static method in class org.planit.output.formatter.OutputFormatterFactory
Create an output formatter based on the passed in class name
createOutputFormatterPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular output formatters are prefixed with the exact same string, i.e.
createOutputTypeAdapter(OutputType) - Method in class org.planit.ltm.trafficassignment.ELTM
Create the output type adapter for the current output type
createOutputTypeAdapter(OutputType) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
Create the output type adapter for the current output type
createOutputTypeAdapter(OutputType) - Method in class org.planit.trafficassignment.TrafficAssignment
Create the output type adapter for the current output type
createProjectPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular project are prefixed with the exact same string, i.e.
createReleaseFlowEvent(TriggerFlowEvent, CumulativePoint, double) - Static method in class org.planit.ltm.event.ReleaseFlowEvent
Create a new release flow event being release on the opposite boundary of the source trigger
createRoute(IdGroupingToken, Centroid, Pair<Double, EdgeSegment>[]) - Static method in interface org.planit.route.Route
Create the route from an implicit origin to a specified destination, using the vertexPathAndCost array as input coming from a shortest path algorithm output This method makes use of the fact that the origin pair in the vertexPathAndCost array has a null EdgeSegment.
createRunIdPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular traffic assignment run are prefixed with the exact same string, i.e.
createTimePeriodPrefix(Object, long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular time period are prefixed with the exact same string, i.e.
createTrafficAssignmentBuilder(InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.ltm.trafficassignment.ELTM
 
createTrafficAssignmentBuilder(InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
create the traffic assignment builder for this traffic assignment
createTrafficAssignmentBuilder(InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Method in class org.planit.trafficassignment.TrafficAssignment
create the traffic assignment builder for this traffic assignment
createTransportNetwork() - Method in class org.planit.trafficassignment.TrafficAssignment
Initialize the transport network by combining the physical and virtual components
createTriggerFlowEvent(LinkSegmentBoundary, CumulativePoint, double) - Static method in class org.planit.ltm.event.TriggerFlowEvent
Create a new trigger flow event emanating from the passing in link boundary at a given cumulative point and flow rate
createZoningPrefix(long) - Static method in class org.planit.utils.misc.LoggingUtils
Create a prefix for the logger so that all logging items specific to a particular zoning are prefixed with the exact same string, i.e.
criticalSpeed - Variable in class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
Maximum speed of mode (tied to a road segment)
csvFileNameMap - Variable in class org.planit.output.formatter.CsvFileOutputFormatter
Map of list of CSV output file names for each OutputType
CsvFileOutputFormatter - Class in org.planit.output.formatter
Class containing common methods required by classes which write results to CSV output files
CsvFileOutputFormatter(IdGroupingToken) - Constructor for class org.planit.output.formatter.CsvFileOutputFormatter
Constructor
CsvTextFileOutputFormatter - Interface in org.planit.output.formatter
This interfaces defines behaviours which output formatters which generate a CSV output file must have.
CumulativeEvent - Class in org.planit.ltm.event
A cumulative event represents a cumulative pcu point in space-time with (potential) additional information.
CumulativeEvent(EventType, Serializable, CumulativePoint, Serializable) - Constructor for class org.planit.ltm.event.CumulativeEvent
Constructor of an LTM cumulative event.
CumulativeEvent(EventType, Serializable, CumulativePoint, Serializable...) - Constructor for class org.planit.ltm.event.CumulativeEvent
Constructor of an LTM cumulative event.
CumulativePoint - Interface in org.planit.utils.cumulatives
Represents a cumulative point in time
CumulativePointImpl - Class in org.planit.utils.cumulatives
Represents a cumulative point in time
CumulativePointImpl(double, double) - Constructor for class org.planit.utils.cumulatives.CumulativePointImpl
Constructor
currentLocation - Variable in class org.planit.od.ODDataIteratorImpl
Marker used to store the current position in the OD matrix (used internally, not accessible from other classes)
currentNetworkSegmentFlows - Variable in class org.planit.data.ModeData
Flows derived for the previous iteration
currentOrigin - Variable in class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
Reference to current origin for which we have collected shortest paths on a ONE-TO-ALL basis
CustomPlanItProject - Class in org.planit.project
The top-level class which hosts a single project.
CustomPlanItProject(InputBuilderListener) - Constructor for class org.planit.project.CustomPlanItProject
Constructor which reads in the input builder listener and instantiates the object factory classes.
CustomPlanItProject.ProjectAssignments - Class in org.planit.project
Internal class for registered traffic assignments

D

deactivateOdSkimOutputType(ODSkimSubOutputType) - Method in class org.planit.output.configuration.OriginDestinationOutputTypeConfiguration
Deactivate an ODSkimOutputType for this output type configuration
deactivateOutput(OutputType) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Deactivate an output type
deactivateOutput(OutputType) - Method in class org.planit.trafficassignment.TrafficAssignment
Deactivate the specified output type
deactivateSubOutputType(SubOutputTypeEnum) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Deactivate a SubOutputTypeEnum for this output type configuration
DEFAULT_ALPHA - Static variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Default alpha BPR parameter if not other information is available
DEFAULT_BETA - Static variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Default beta BPR parameter if not other information is available
DEFAULT_CAPACITY_LANE - Static variable in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Default capacity per lane (veh/h)
DEFAULT_CONNECTOID_SPEED_KPH - Static variable in class org.planit.cost.virtual.SpeedConnectoidTravelTimeCost
 
DEFAULT_CRITICAL_SPEED - Static variable in interface org.planit.utils.network.physical.macroscopic.MacroscopicModeProperties
Default critical speed, i.e.
DEFAULT_EPSILON - Static variable in class org.planit.gap.StopCriterion
Default Epsilon in case it is not set by user
DEFAULT_EXTERNAL_ID - Static variable in class org.planit.userclass.TravelerType
If no user class is defined the default user class will be assumed to have a traveler type referencing the default external traveler type id (1)
DEFAULT_EXTERNAL_ID - Static variable in class org.planit.userclass.UserClass
Default external id
DEFAULT_EXTERNAL_ID - Static variable in interface org.planit.utils.network.physical.Mode
If no mode is defined the default mode is assumed to have an external idf of 1
DEFAULT_LENGTH_KM - Static variable in interface org.planit.utils.network.virtual.Connectoid
Default connectoid length in km
DEFAULT_MAX_ITERATIONS - Static variable in class org.planit.gap.StopCriterion
Default maximum number of iterations in case it is not set by user
DEFAULT_MAX_SPEED - Static variable in interface org.planit.utils.network.physical.LinkSegment
Default maximum speed on a link segment
DEFAULT_MAXIMUM_SPEED - Static variable in interface org.planit.utils.network.physical.macroscopic.MacroscopicModeProperties
Default max speed in km/h
DEFAULT_NAME - Static variable in class org.planit.userclass.TravelerType
 
DEFAULT_NAME - Static variable in class org.planit.userclass.UserClass
default name
DEFAULT_NUMBER_OF_LANES - Static variable in interface org.planit.utils.network.physical.LinkSegment
Default number of lanes
DEFAULT_SEPARATOR - Static variable in class org.planit.io.input.PlanItInputBuilder
The default separator that is assumed when no separator is provided
DEFAULT_SPEED_EPSILON - Static variable in interface org.planit.utils.network.physical.macroscopic.MacroscopicModeProperties
Epsilon margin when comparing speeds (km/h)
defaultParameters - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Default alpha and beta values for all links
defaultParametersPerLinkSegmentTypeAndMode - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Map to store default alpha and beta values for each link type and mode
defaultParametersPerMode - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Map to store default alpha and beta values for each mode
delayedMethodCalls - Variable in class org.planit.configurator.Configurator
the methods to invoke on the to be configured object instance and their parameters
demands - Variable in class org.planit.project.CustomPlanItProject
The registered demands
demands - Variable in class org.planit.project.PlanItProjectInput
The registered demands
demands - Variable in class org.planit.trafficassignment.TrafficAssignment
The demand to use
Demands - Class in org.planit.demands
Container class for all demands registered on the project.
Demands(IdGroupingToken) - Constructor for class org.planit.demands.Demands
Constructor
Demands.TimePeriods - Class in org.planit.demands
Inner class to register and store time periods for the current demand object
Demands.TravelerTypes - Class in org.planit.demands
Inner class to register and store traveler types for the current demand object
Demands.UserClasses - Class in org.planit.demands
Inner class to register and store user classes for the current demand object
demandsFactory - Variable in class org.planit.project.PlanItProjectInput
Object factory for demands object
demandsMap - Variable in class org.planit.project.PlanItProjectInput
The demands registered on this project
DemandsPopulator - Class in org.planit.io.xml.demands
This class contains methods to populate the Demands object using input values from the XML demands input file.
DemandsPopulator() - Constructor for class org.planit.io.xml.demands.DemandsPopulator
 
DENSITY - org.planit.output.property.OutputProperty
 
DensityOutputProperty - Class in org.planit.output.property
 
DensityOutputProperty() - Constructor for class org.planit.output.property.DensityOutputProperty
 
deregisterOutputTypeAdapter(OutputType) - Method in class org.planit.output.adapter.OutputAdapter
Deregister an output type adapter for a specified output type
deregisterOutputTypeAdapter(OutputType) - Method in class org.planit.output.OutputManager
Deregister the output adapter for a specified output type
deregisterOutputTypeConfiguration(OutputType) - Method in class org.planit.output.OutputManager
Remove the output type configuration for a specified output type
DESTINATION_ZONE_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
DESTINATION_ZONE_ID - org.planit.output.property.OutputProperty
 
destinationId - Variable in class org.planit.od.ODDataIteratorImpl
Id of the destination zone
DestinationZoneExternalIdOutputProperty - Class in org.planit.output.property
 
DestinationZoneExternalIdOutputProperty() - Constructor for class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
DestinationZoneIdOutputProperty - Class in org.planit.output.property
 
DestinationZoneIdOutputProperty() - Constructor for class org.planit.output.property.DestinationZoneIdOutputProperty
 
DijkstraShortestPathAlgorithm - Class in org.planit.algorithms.shortestpath
Dijkstra's shortest path algorithm Dijkstra's shortest path is a one-to-all implementation of the shortest path algorithm based on the generalized costs on each link segment (edge).
DijkstraShortestPathAlgorithm(double[], int, int) - Constructor for class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
Constructor for an edge cost based Dijkstra algorithm for finding shortest paths.
disbandTransportNetwork() - Method in class org.planit.trafficassignment.TrafficAssignment
detach the virtual and physical transport network again
disconnectVerticesFromEdge(Edge) - Method in class org.planit.network.transport.TransportNetwork
Remove Edge from both vertices
disconnectVerticesFromEdgeSegment(EdgeSegment) - Method in class org.planit.network.transport.TransportNetwork
Remove edge segment from the incoming or outgoing set of edge segments for the related vertices
dotProduct(double[], double[], int) - Static method in class org.planit.utils.arrays.ArrayOperations
Return the dot product of two arrays The dot product is found by multiplying the elements of each array at each position together and then taking the sum of the multiplied values e.g.
DOUBLE - org.planit.output.enums.Type
 
doubleValue() - Method in class org.planit.utils.function.NullaryDoubleSupplier
DOWNSTREAM - org.planit.ltm.LinkSegmentBoundary.Location
 
DOWNSTREAM_NODE_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
DOWNSTREAM_NODE_ID - org.planit.output.property.OutputProperty
 
DOWNSTREAM_NODE_LOCATION - org.planit.output.property.OutputProperty
 
DownstreamNodeExternalIdOutputProperty - Class in org.planit.output.property
 
DownstreamNodeExternalIdOutputProperty() - Constructor for class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
DownstreamNodeIdOutputProperty - Class in org.planit.output.property
 
DownstreamNodeIdOutputProperty() - Constructor for class org.planit.output.property.DownstreamNodeIdOutputProperty
 
DownstreamNodeLocationOutputProperty - Class in org.planit.output.property
 
DownstreamNodeLocationOutputProperty() - Constructor for class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
downstreamVertex - Variable in class org.planit.graph.EdgeSegmentImpl
The downstream vertex of this edge segment
DynamicTrafficAssignment - Class in org.planit.trafficassignment
Dynamic traffic assignment class for any traffic assignment model that adheres to being capacity constrained utilizing a fundamental diagram and underlying node model
DynamicTrafficAssignment(IdGroupingToken) - Constructor for class org.planit.trafficassignment.DynamicTrafficAssignment
Constructor
DynamicTrafficAssignmentBuilder - Class in org.planit.trafficassignment.builder
A dynamic traffic assignment builder is assumed to only support capacity constrained traffic assignment instances.
DynamicTrafficAssignmentBuilder(DynamicTrafficAssignment, InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Constructor for class org.planit.trafficassignment.builder.DynamicTrafficAssignmentBuilder
Constructor

E

Edge - Interface in org.planit.utils.graph
Edge interface connecting two vertices in a non-directional fashion.
EdgeImpl - Class in org.planit.graph
Edge class connecting two vertices via some geometry.
EdgeImpl(IdGroupingToken, Vertex, Vertex, double) - Constructor for class org.planit.graph.EdgeImpl
Constructor which injects link lengths directly
edges - Variable in class org.planit.graph.VertexImpl
edge container
edges - Variable in class org.planit.graph.VertexImpl.EdgesImpl
 
EdgeSegment - Interface in org.planit.utils.graph
EdgeSegment represents an edge in a particular (single) direction.
edgeSegmentAB - Variable in class org.planit.graph.EdgeImpl
Edge segment A to B direction
edgeSegmentBA - Variable in class org.planit.graph.EdgeImpl
Edge segment B to A direction
edgeSegmentCosts - Variable in class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
Track the cost for each edge to determine shortest paths
EdgeSegmentImpl - Class in org.planit.graph
EdgeSegment represents an edge in a particular (single) direction.
EdgeSegmentImpl(IdGroupingToken, Edge, boolean) - Constructor for class org.planit.graph.EdgeSegmentImpl
Constructor
edgeSegments - Variable in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
Edge segments which connect to this vertex
EdgeSegmentsImpl() - Constructor for class org.planit.graph.VertexImpl.EdgeSegmentsImpl
 
EdgesImpl() - Constructor for class org.planit.graph.VertexImpl.EdgesImpl
 
ELTM - Class in org.planit.ltm.trafficassignment
event based Link Transmission Model implementation (eLTM) for network loading using a capacity constrained (Deterministic) assignment
ELTM(IdGroupingToken) - Constructor for class org.planit.ltm.trafficassignment.ELTM
Constructor
ELTMTrafficAssignmentBuilder - Class in org.planit.ltm.trafficassignment
The eLTM traffic assignment builder.
ELTMTrafficAssignmentBuilder(DynamicTrafficAssignment, InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Constructor for class org.planit.ltm.trafficassignment.ELTMTrafficAssignmentBuilder
Constructor
entryEdgeSegments - Variable in class org.planit.graph.VertexImpl
entryEdgeSegment container
EnumConverter - Interface in org.planit.io.xml.converter
Utility methods to convert enumerations from the PLANit org.planit.output.enums package into enumerations generated from the output XSD file
EPSILON_6 - Static variable in class org.planit.utils.math.Precision
 
equals(Object) - Method in class org.planit.output.property.BaseOutputProperty
Overridden equals() method This method is needed to allow output properties to be removed from the output list if required.
equals(Object) - Method in class org.planit.utils.misc.Pair
Compare to another pair
equals(LinkSegmentExpectedResultsDto) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Tests whether this ResultDto object is equal to another one
execute() - Method in class org.planit.io.PlanItMain
Top-level business method for the PlanItXmlMain program.
execute() - Method in class org.planit.trafficassignment.TrafficAssignment
Execute assignment, including initializing resources, running equilibration and then closing resources
executeAllTrafficAssignments() - Method in class org.planit.io.project.PlanItSimpleProject
Execute all registered traffic assignments Top-level error recording is done in this class.
executeAllTrafficAssignments() - Method in class org.planit.project.CustomPlanItProject
Execute all registered traffic assignments Top-level error recording is done in this class.
executeEquilibration() - Method in class org.planit.ltm.trafficassignment.ELTM
Run equilibration after resources initialized, including saving results
executeEquilibration() - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
Execute equilibration over all time periods and modes
executeEquilibration() - Method in class org.planit.trafficassignment.TrafficAssignment
Run equilibration after resources initialized, including saving results
executeOneToAll(Vertex) - Method in class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
Construct shortest paths from source node to all other nodes in the network based on directed LinkSegment edges
executeOneToAll(Vertex) - Method in interface org.planit.algorithms.shortestpath.ShortestPathAlgorithm
Construct shortest paths from source node to all other nodes in the network based on directed LinkSegment edges
executeTrafficAssignment(TrafficAssignment) - Method in class org.planit.project.CustomPlanItProject
Execute a particular traffic assignment
exitEdgeSegments - Variable in class org.planit.graph.VertexImpl
exitEdgeSegmentcontainer
externalId - Variable in class org.planit.graph.EdgeSegmentImpl
The external Id for this link segment type
externalId - Variable in class org.planit.network.physical.LinkImpl
External Id of the physical link
externalId - Variable in class org.planit.network.physical.NodeImpl
External identifier used in input files
externalId - Variable in class org.planit.network.virtual.ConnectoidImpl
External Id of the connectoid
externalId - Variable in class org.planit.network.virtual.ZoneImpl
External Id for this zone

F

FileOutputFormatter - Class in org.planit.output.formatter
Common methods used by output formatters which write data to physical files
FileOutputFormatter(IdGroupingToken) - Constructor for class org.planit.output.formatter.FileOutputFormatter
Constructor
finaliseAfterSimulation() - Method in class org.planit.output.OutputManager
Allows the output manager to finalise itself and any of its registered output formatters to after the simulation ended
finaliseAfterSimulation(Map<OutputType, OutputTypeConfiguration>, OutputAdapter) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Finalize the persistence after the simulation.
finaliseAfterSimulation(Map<OutputType, OutputTypeConfiguration>, OutputAdapter) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Close all resources used in this formatter
finaliseAfterSimulation(Map<OutputType, OutputTypeConfiguration>, OutputAdapter) - Method in interface org.planit.output.formatter.OutputFormatter
Close resources to store results
finalizeAfterExecution() - Method in class org.planit.trafficassignment.TrafficAssignment
Finalize all relevant traffic assignment components after execution of the assignment has ended
findMacroscopicLinkSegmentTypeById(long) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Return a link segment type identified by its generated id
findMostRestrictingOutLinkSegmentIndex() - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Find most restricted unprocessed outgoing link segment based on the scaled sending flows
first - Variable in class org.planit.utils.misc.Pair
The first object in this Pair
FIXED - Static variable in class org.planit.cost.virtual.VirtualCost
short hand for configuring fixed virtual cost instance
fixedConnectoidCost - Variable in class org.planit.cost.virtual.FixedConnectoidTravelTimeCost
Fixed connectoid cost for connectoid segments - defaults to zero
FixedConnectoidTravelTimeCost - Class in org.planit.cost.virtual
Class holding fixed connectoid costs for each connectoid segment
FixedConnectoidTravelTimeCost(IdGroupingToken) - Constructor for class org.planit.cost.virtual.FixedConnectoidTravelTimeCost
Constructor
fixedInput - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelInput
fixed inputs to use
FLOAT - org.planit.output.enums.Type
 
FLOW - org.planit.output.property.OutputProperty
 
FlowOutputProperty - Class in org.planit.output.property
 
FlowOutputProperty() - Constructor for class org.planit.output.property.FlowOutputProperty
 
format5(double) - Static method in class org.planit.utils.output.FormatUtils
Outputs a double to five decimal places
format6(double) - Static method in class org.planit.utils.output.FormatUtils
Outputs a double to six decimal places
formatObject(Object) - Static method in class org.planit.utils.output.OutputUtils
Formats an object (if a double, outputs value to 7 decimal places
FormatUtils - Class in org.planit.utils.output
Utility methods for formatting doubles
FormatUtils() - Constructor for class org.planit.utils.output.FormatUtils
 
fromHeaderName(String) - Static method in enum org.planit.output.property.OutputProperty
Returns the enumeration value associated with a specified header name (the header name in input and output files)
fromValue(String) - Static method in enum org.planit.output.property.OutputProperty
Returns the enumeration value associated with the specified class name
fundamentalDiagram - Variable in class org.planit.trafficassignment.CapacityConstrainedAssignment
Fundamental diagram to use
FundamentalDiagram - Class in org.planit.supply.fundamentaldiagram
Fundamental diagram traffic component
FundamentalDiagram(IdGroupingToken) - Constructor for class org.planit.supply.fundamentaldiagram.FundamentalDiagram
Base constructor
fundamentalDiagramFactory - Variable in class org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder
fundamental diagram factory to create fundamental diagrams used to populate the link model

G

gap - Variable in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Gap
GapFunction - Class in org.planit.gap
Interface for computing gap functions
GapFunction(StopCriterion) - Constructor for class org.planit.gap.GapFunction
Constructor
GENERAL - org.planit.output.enums.OutputType
 
generateAndStoreConfigurationData(Demands, XMLElementDemandConfiguration, PhysicalNetwork, InputBuilderListener) - Static method in class org.planit.io.xml.demands.ProcessConfiguration
Sets up all the configuration data from the XML demands file
generateConnectoidId(IdGroupingToken) - Static method in class org.planit.network.virtual.ConnectoidImpl
Generate connectoid id
generateConnectoidSegmentId(IdGroupingToken) - Static method in class org.planit.network.virtual.ConnectoidSegmentImpl
generate unique connectoid segment id
generateEdgeId(IdGroupingToken) - Static method in class org.planit.graph.EdgeImpl
Generate edge id
generateEdgeSegmentId(IdGroupingToken) - Static method in class org.planit.graph.EdgeSegmentImpl
Generate unique edge segment id
generateEventId() - Static method in class org.planit.ltm.event.CumulativeEvent
Event ids are generated with unique ids across all cumulative events in the JVM
generateId(IdGroupingToken, Class<? extends Object>) - Static method in class org.planit.utils.id.IdGenerator
Generate a unique id for the chosen class
generateLinkId(IdGroupingToken) - Static method in class org.planit.network.physical.LinkImpl
generate unique link id
generateLinkSegmentId(IdGroupingToken) - Static method in class org.planit.network.physical.LinkSegmentImpl
Generate unique link segment id
generateMacroscopicLinkSegmentTypeId(IdGroupingToken) - Static method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Generate next id available
generateNodeId(IdGroupingToken) - Static method in class org.planit.network.physical.NodeImpl
generate unique node id
generateObjectFromXml(Class<?>, String) - Static method in interface org.planit.io.xml.util.XmlUtils
Generates a Java object populated with the data from an XML input file.
generateOutputFileName(String, String, String, TimePeriod, OutputType, long) - Method in class org.planit.output.formatter.FileOutputFormatter
Generates the name of an output file.
generateOutputFileName(String, String, String, TimePeriod, OutputType, long, int) - Method in class org.planit.output.formatter.FileOutputFormatter
Generates the name of an output file.
generateVertexId(IdGroupingToken) - Static method in class org.planit.graph.VertexImpl
generate unique node id
generateXmlFileFromObject(Object, Class<?>, String) - Static method in interface org.planit.io.xml.util.XmlUtils
Creates an XML output file populated with data from an Object
generateZoneId(IdGroupingToken) - Static method in class org.planit.network.virtual.ZoneImpl
Generate unique id for this zone
get(Mode, TimePeriod) - Method in class org.planit.demands.Demands
Get an ODDemand by mode and time period
getA() - Method in class org.planit.utils.test.TestOutputDto
 
getAbsCumulativeDifferenceWith(CumulativePoint) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Absolute cumulative difference between this and passed in cumulative point
getAbsCumulativeDifferenceWith(CumulativePoint) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Absolute cumulative difference between this and passed in cumulative point
getAbsTimeDifferenceWith(CumulativePoint) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Absolute time difference in seconds between this and passed in cumulative point
getAbsTimeDifferenceWith(CumulativePoint) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Absolute time difference in seconds between this and passed in cumulative point
getActiveSkimOutputTypes() - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Returns a Set of activated OD skim output types
getActiveSubOutputTypes() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Returns a set of activated sub output types (if any)
getActualSystemTravelTime() - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Return the actual system travel time
getAllModes() - Method in class org.planit.input.InputBuilderListener
Return all the registered modes
getAlphaBetaParameters(Mode) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost.BPRParameters
Retrieve Pair containing alpha and beta values for a specified mode
getAssignmentClassName() - Method in class org.planit.output.adapter.OutputAdapter
Returns the name of the assignment class being used
getB() - Method in class org.planit.utils.test.TestOutputDto
 
getC() - Method in class org.planit.utils.test.TestOutputDto
 
getCallingClassName() - Static method in class org.planit.utils.reflection.StackWalkerUtil
Collect the class name of the method that is the invoker of calling this method
getCallingMethodName() - Static method in class org.planit.utils.reflection.StackWalkerUtil
Collect the method name of the method that is the invoker of calling this method
getCallingMethodType() - Static method in class org.planit.utils.reflection.StackWalkerUtil
Collect the method type of the method that is the invoker of calling this method
getCapacity() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Returns the capacity of this link
getCapacityPerLane() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getCapacityPerLane() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
getCapacityPerLane() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return the capacity per lane of this macroscopic link segment type
getCapacityPerLane(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the value of the capacity per lane
getCapacityScalingFactors() - Method in class org.planit.algorithms.nodemodel.TampereNodeModelInput
Collect the computed capacity scaling factors per in-link segment a such that lambda_a = C_a/Sum_b(t_ab)
getCentrePointGeometry() - Method in class org.planit.graph.VertexImpl
Collect the geometry of the point location of this vertex
getCentrePointGeometry() - Method in interface org.planit.utils.graph.Vertex
Collect the geometry of the point location of this vertex
getCentrePointGeometry(XMLElementZones.Zone) - Static method in class org.planit.io.xml.zoning.UpdateZoning
Generates an OpenGIS DirectPosition object for the Centroid location from the generated Zone object
getCentroid() - Method in class org.planit.network.virtual.ZoneImpl
Returns the centroid of this zone
getCentroid() - Method in interface org.planit.utils.network.virtual.Zone
Returns the centroid of this zone
getClassName(Object) - Method in class org.planit.output.adapter.OutputAdapter
Return the name of a Java object class as a short string
getClassNameWithBrackets(Object) - Static method in class org.planit.utils.misc.LoggingUtils
create a string that gets the class simple name and surrounds them with brackets
getColumnPriority() - Method in class org.planit.output.property.BaseOutputProperty
Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file
getColumnPriority() - Method in class org.planit.output.property.CalculatedSpeedOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.CapacityPerLaneOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.CostTimesFlowOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DensityOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DestinationZoneIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.FlowOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.IterationIndexOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.LengthOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.LinkCostOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.LinkSegmentIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.LinkTypeOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.MaximumDensityOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.MaximumSpeedOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.ModeExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.ModeIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.NumberOfLanesOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.ODCostOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.OriginZoneIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.PathIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.PathOutputStringProperty
 
getColumnPriority() - Method in class org.planit.output.property.RunIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.TimePeriodIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
getColumnPriority() - Method in class org.planit.output.property.VCRatioOutputProperty
 
getCommonPropertyValue(OutputProperty, Mode, TimePeriod) - Method in class org.planit.output.adapter.OutputTypeAdapterImpl
Returns the value of properties which are common to all output type adapters
getConnectoid(long) - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Get connectoid by id
getConnectoidId() - Method in class org.planit.network.virtual.ConnectoidImpl
Return the id of this connectoid
getConnectoidId() - Method in interface org.planit.utils.network.virtual.Connectoid
Return the unique id of this connectoid
getConnectoidSegment(long) - Method in class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
Get connectoid segment by id
getConnectoidSegmentId() - Method in class org.planit.network.virtual.ConnectoidSegmentImpl
 
getConnectoidSegmentId() - Method in interface org.planit.utils.network.virtual.ConnectoidSegment
Collect the unqiue connectoid segment id
getCriticalSpeed() - Method in class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
 
getCriticalSpeed() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicModeProperties
Collect the critical speed in km/h
getCsvFileName(OutputType) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Returns the list of names of CSV output file for a specified output type
getCsvFileName(OutputType) - Method in interface org.planit.output.formatter.CsvTextFileOutputFormatter
Returns a list of names of CSV output file for a specified output type
getCumulativeCount() - Method in interface org.planit.utils.cumulatives.CumulativePoint
 
getCumulativeCount() - Method in class org.planit.utils.cumulatives.CumulativePointImpl
 
getCumulativePoint() - Method in class org.planit.ltm.event.CumulativeEvent
 
getCurrentDestination() - Method in interface org.planit.od.ODDataIterator
Returns the destination zone object for the current cell
getCurrentDestination() - Method in class org.planit.od.ODDataIteratorImpl
Returns the destination zone object for the current cell
getCurrentOrigin() - Method in interface org.planit.od.ODDataIterator
Returns the origin zone object for the current cell
getCurrentOrigin() - Method in class org.planit.od.ODDataIteratorImpl
Returns the origin zone object for the current cell
getCurrentValue() - Method in interface org.planit.od.ODDataIterator
Returns the value at the current cell
getCurrentValue() - Method in class org.planit.od.odmatrix.ODMatrixIterator
Returns the value at the current cell
getCurrentValue() - Method in class org.planit.od.odroute.ODRouteIterator
Returns the path in the current cell
getDefaultOutputFormatter() - Method in class org.planit.io.project.PlanItSimpleProject
Collect the default output formatter for PLANit simple project which is the native XMLFormatter
getDemands() - Method in class org.planit.io.project.PlanItSimpleProject
Return the current Demands object
getDemands(long) - Method in class org.planit.project.PlanItProjectInput.ProjectDemands
Get demands by id
getDescription() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Collect the description property
getDescription() - Method in class org.planit.time.TimePeriod
Return the description
getDestinationZoneExternalId(ODMatrixIterator) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the external Id of the destination zone for the current cell in the OD skim matrix
getDestinationZoneExternalId(ODRouteIterator) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the external Id of the destination zone for the current cell in the OD path matrix
getDestinationZoneId(ODMatrixIterator) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the Id of the destination zone for the current cell in the OD skim matrix
getDestinationZoneId(ODRouteIterator) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the Id of the destination zone for the current cell in the OD path matrix
getDirectPositionFromPointType(PlanitGeoUtils, PointType) - Static method in interface org.planit.io.xml.util.XmlUtils
Create GML position from generated PointType object
getDirectPositionFromValues(double, double) - Method in class org.planit.geo.PlanitGeoUtils
Create DirectPosition object from X- and Y-coordinates
getDistanceInKilometres(Position, Position) - Method in class org.planit.geo.PlanitGeoUtils
Compute the distance in kilometres between two positions in a geodetic coordinate reference system
getDownstreamNodeExternalId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the external Id of the downstream node
getDownstreamNodeId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the Id of the downstream node
getDownstreamNodeLocation(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the location of the downstream node
getDownstreamVertex() - Method in class org.planit.graph.EdgeSegmentImpl
Get the segment's downstream vertex
getDownstreamVertex() - Method in interface org.planit.utils.graph.EdgeSegment
Get the segment's downstream vertex
getDurationSeconds() - Method in class org.planit.time.TimePeriod
Return the duration in seconds
getEdges() - Method in class org.planit.graph.VertexImpl.EdgesImpl
#Returns a Set of Edge objects
getEdges() - Method in class org.planit.graph.VertexImpl
#Collect the edges of this vertex
getEdges() - Method in interface org.planit.utils.graph.Vertex.Edges
Returns a Set of Edge objects
getEdges() - Method in interface org.planit.utils.graph.Vertex
Collect the edges of this vertex
getEdgeSegmentAB() - Method in class org.planit.graph.EdgeImpl
Edge segment in the direction from A to B
getEdgeSegmentAB() - Method in interface org.planit.utils.graph.Edge
Edge segment in the direction from A to B
getEdgeSegmentBA() - Method in class org.planit.graph.EdgeImpl
Edge segment in the direction from B to A
getEdgeSegmentBA() - Method in interface org.planit.utils.graph.Edge
Edge segment in the direction from B to A
getEndNodeId() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Return the id of the end node
getEntryEdgeSegments() - Method in class org.planit.graph.VertexImpl
#Collect the entry edge segments of this vertex
getEntryEdgeSegments() - Method in interface org.planit.utils.graph.Vertex
Collect the entry edge segments of this vertex
getEpsilon() - Method in class org.planit.gap.StopCriterion
Return the epsilon of this stopping criterion
getEventContentByIndex(int) - Method in class org.planit.ltm.event.CumulativeEvent
Collect any entry from the event content object array by index and cast to generic type T
getExitEdgeSegments() - Method in class org.planit.graph.VertexImpl
#Collect the exit edge segments of this vertex
getExitEdgeSegments() - Method in interface org.planit.utils.graph.Vertex
Collect the exit edge segments of this vertex
getExternalId() - Method in class org.planit.graph.EdgeSegmentImpl
Get external id of the instance.
getExternalId() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getExternalId() - Method in class org.planit.network.physical.LinkImpl
 
getExternalId() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
getExternalId() - Method in class org.planit.network.physical.ModeImpl
 
getExternalId() - Method in class org.planit.network.physical.NodeImpl
Collect the external id of the node
getExternalId() - Method in class org.planit.network.virtual.ConnectoidImpl
 
getExternalId() - Method in class org.planit.network.virtual.ZoneImpl
 
getExternalId() - Method in class org.planit.time.TimePeriod
Return the external id of this time period
getExternalId() - Method in class org.planit.userclass.TravelerType
 
getExternalId() - Method in class org.planit.userclass.UserClass
Get the external id of this user class
getExternalId() - Method in interface org.planit.utils.graph.EdgeSegment
Get external id of the instance.
getExternalId() - Method in interface org.planit.utils.network.physical.Link
Collect the external id
getExternalId() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return the external id of this macroscopic link segment type
getExternalId() - Method in interface org.planit.utils.network.physical.Mode
Return the external id of this mode
getExternalId() - Method in interface org.planit.utils.network.physical.Node
Collect the external id of the node
getExternalId() - Method in interface org.planit.utils.network.virtual.Connectoid
Collect the external id of this connectoid
getExternalId() - Method in interface org.planit.utils.network.virtual.Zone
Returns the external id of this zone
getFirst() - Method in class org.planit.demands.Demands.TimePeriods
Collect the first registered time period.
getFirst() - Method in class org.planit.demands.Demands.TravelerTypes
Collect the first registered traveler type.
getFirst() - Method in class org.planit.demands.Demands.UserClasses
Collect the first registered user class.
getFirst() - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Collect the first registered mode
getFirst() - Method in class org.planit.utils.misc.Pair
Get first object in pair
getFirstDemands() - Method in class org.planit.project.PlanItProjectInput.ProjectDemands
Collect the first demands that are registered (if any).
getFirstNetwork() - Method in class org.planit.project.PlanItProjectInput.ProjectNetworks
Collect the first network that is registered (if any).
getFirstODRouteMatrix() - Method in class org.planit.route.ODRouteSets
Collect the first od route matrix available
getFirstODRouteSets() - Method in class org.planit.project.PlanItProjectInput.ProjectODRouteSets
Collect the first od route set that is registered (if any).
getFirstStackFrame() - Static method in class org.planit.utils.reflection.StackWalkerUtil
Collect the first available stack frame if it exists
getFirstTrafficAssignment() - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
Collect the first traffic assignment that is registered (if any).
getFirstZoning() - Method in class org.planit.project.PlanItProjectInput.ProjectZonings
Collect the first zonings that are registered (if any).
getGap() - Method in class org.planit.gap.GapFunction
Returns the gap for the current iteration
getGap() - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Return the gap for the current iteration
getGapFunction() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Collect the gap function of the trafficAssignment instance
getGapFunction() - Method in class org.planit.trafficassignment.TrafficAssignment
Collect the gap function which is to be set by a derived class of TrafficAssignment via the initialiseDefaults() right after construction
getGapFunctionClassName() - Method in class org.planit.output.adapter.OutputAdapter
Return the name of the gap function class
getId() - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Collect initial cost id
getId() - Method in class org.planit.graph.EdgeImpl
Return id of this instance.
getId() - Method in class org.planit.graph.EdgeSegmentImpl
Unique id of the edge segment
getId() - Method in class org.planit.graph.VertexImpl
#Return id of this instance.
getId() - Method in class org.planit.ltm.event.CumulativeEvent
 
getId() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
getId() - Method in class org.planit.network.physical.ModeImpl
 
getId() - Method in class org.planit.network.virtual.ZoneImpl
Returns the id of this zone
getId() - Method in class org.planit.od.odroute.ODRouteMatrix
 
getId() - Method in class org.planit.output.formatter.BaseOutputFormatter
 
getId() - Method in interface org.planit.output.formatter.OutputFormatter
Collect the id of the formatter
getId() - Method in interface org.planit.route.Route
Return the Id of this path
getId() - Method in class org.planit.route.RouteImpl
Return the id of this path
getId() - Method in class org.planit.time.TimePeriod
Return the id of this time period
getId() - Method in class org.planit.trafficassignment.TrafficAssignmentComponent
All traffic components must have a unique id
getId() - Method in class org.planit.userclass.TravelerType
 
getId() - Method in class org.planit.userclass.UserClass
Get the id of this user class
getId() - Method in interface org.planit.utils.graph.Edge
Return id of this instance.
getId() - Method in interface org.planit.utils.graph.EdgeSegment
Return id of this instance.
getId() - Method in interface org.planit.utils.graph.Vertex
Return id of this instance.
getId() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return the unique id of this macroscopic link segment type
getId() - Method in interface org.planit.utils.network.physical.Mode
Return id of this instance.
getId() - Method in interface org.planit.utils.network.virtual.Zone
Returns the unique id of this zone
getIdGroupingtoken() - Method in class org.planit.trafficassignment.TrafficAssignmentComponent
Collect the id grouping token used to generate ids for entities of this class.
getIdGroupingToken() - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Collect the id grouping token used by this builder
getIdGroupingToken() - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Collect the id grouping token used by this builder
getInitialLinkSegmentCost(PhysicalNetwork) - Method in class org.planit.project.CustomPlanItProject
Return the initial link segment costs for a network
getInitialLinkSegmentCost(PhysicalNetwork) - Method in class org.planit.project.PlanItProjectInput
Return the initial link segment costs for a network
getInputProperty(String) - Method in class org.planit.graph.EdgeImpl
Get input property by its key
getInputProperty(String) - Method in class org.planit.graph.VertexImpl
Get input property by its key
getInputProperty(String) - Method in class org.planit.network.virtual.ZoneImpl
Get input property by its key
getInputProperty(String) - Method in interface org.planit.utils.graph.Edge
Get input property by its key
getInstance(boolean, IterableMap<Object, Object[]>, MultiKeyMap<Object, Object[]>) - Static method in interface org.planit.data.MultiKeyPlanItDataIterator
Returns an instance of a class which implements this interface
getIterationIndex() - Method in class org.planit.data.SimulationData
Returns the current iteration index
getIterationIndex(TrafficAssignment) - Static method in class org.planit.output.property.IterationIndexOutputProperty
Returns the current iteration index
getIterationIndexForSubOutputType(SubOutputTypeEnum) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
ODSkimOutputType.COST: Cost is collected through the shortest path in iteration i based on the link costs of iteration i-1, so the od cost of i-1 are only known once we are in iteration i, hence this information is trailing behind one iteration, and we can only store it in i.
getIterationIndexForSubOutputType(SubOutputTypeEnum) - Method in interface org.planit.output.adapter.OutputTypeAdapter
Determine the iteration index that is relevant for the data related to the provided output type enum Generally, this equates to the actual current iteration index, but if the data for example is trailing an iteration then this will collect the correct iteration index for this data as opposed to the iteration index of the simulation itself.
getIterationIndexForSubOutputType(SubOutputTypeEnum) - Method in class org.planit.output.adapter.OutputTypeAdapterImpl
Default implementation assumes that regular iteration index is used, which in most cases it true, only when for example costs are trailing one iteration behind in case they are only revealed in the next iteration this method should be overridden
getIterator() - Method in class org.planit.data.MultiKeyPlanItData
Returns a MultiKeyPlanItDataIterator for the contents of this map
getIterator() - Method in interface org.planit.route.Route
Iterator over the available edge segments
getIterator() - Method in class org.planit.route.RouteImpl
Iterator over the available edge segments
getIterator(Mode, TimePeriod, Integer, OutputType) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns a MemoryOutputIterator for the contents of the specified MultiKeyPlanItData map
getKeys() - Method in interface org.planit.data.MultiKeyPlanItDataIterator
Returns an array of keys for the current iteration
getKeys() - Method in class org.planit.data.MultiKeyPlanItDataIteratorImpl
Returns an array of keys for the current iteration
getKeys() - Method in class org.planit.output.formatter.MemoryOutputIterator
Returns an array of keys for the current iteration
getLastIteration() - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns the value of the last iteration of recorded data
getLength() - Method in class org.planit.graph.EdgeImpl
Return length of this edge in km
getLength() - Method in interface org.planit.utils.graph.Edge
Return length of this edge in km
getLength() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Returns the length of this link
getLength(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the length of the current link segment
getLink(long) - Method in class org.planit.network.physical.PhysicalNetwork.Links
Get link by id
getLinkBoundary() - Method in class org.planit.ltm.event.TriggerEvent
 
getLinkBoundaryLocation() - Method in class org.planit.ltm.event.ReleaseEvent
collect the link boundary location of this release event, i.e., the opposite link boundary of its source trigger event
getLinkCost() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Get the cost for the current link
getLinkFlow() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Return the flow through this link
getLinkId() - Method in class org.planit.network.physical.LinkImpl
 
getLinkId() - Method in interface org.planit.utils.network.physical.Link
Return id of this instance.
getLinkOutputPropertyValue(OutputProperty, LinkSegment, Mode, TimePeriod, double) - Method in interface org.planit.output.adapter.LinkOutputTypeAdapter
Return the value of a specified output property of a link segment
getLinkOutputPropertyValue(OutputProperty, LinkSegment, Mode, TimePeriod, double) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Return the value of a specified output property of a link segment The DENSITY case should never be called for TraditionalStaticAssignment.
getLinkOutputPropertyValue(OutputProperty, LinkSegment, Mode, TimePeriod, double) - Method in class org.planit.output.adapter.TraditionalStaticAssignmentLinkOutputTypeAdapter
Return the value of a specified output property of a link segment
getLinkSegment(long) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Get link segment by id
getLinkSegmentByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Returns the link segment for a given external Id
getLinkSegmentByExternalId(Object) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Retrieve a link segment by its external Id This method is not efficient, since it loops through all the registered modes in order to find the required link segment.
getLinkSegmentByExternalId(Object, boolean) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Retrieve a link segment by its external Id This method has the option to convert the external Id parameter into a long value, to find the link segment type when link segment type objects use long values for external ids.
getLinkSegmentByStartAndEndNodeId(long, long) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Find a LinkSegment by the external Ids of its start and end nodes
getLinkSegmentExternalId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the external Id of the current link segment
getLinkSegmentId() - Method in class org.planit.network.physical.LinkSegmentImpl
 
getLinkSegmentId() - Method in interface org.planit.utils.network.physical.LinkSegment
Return id of this instance.
getLinkSegmentId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the Id of the current link segment
getLinkSegmentType() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
 
getLinkSegmentType() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegment
Collect the link segment type of the link segment
getLinkSegmentTypeByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return the link segment type for a specified external Id
getLinkType(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Return the link segment type of the current link segment
getLocation() - Method in class org.planit.ltm.LinkSegmentBoundary
Collect the boundary location of this instance
getMacroscopicLinkSegmentTypeByExternalId(Object) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Retrieve a link segment type by its external Id This method is not efficient, since it loops through all the registered modes in order to find the required link segment type.
getMacroscopicLinkSegmentTypeByExternalId(Object, boolean) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Retrieve a link segment type by its external Id This method has the option to convert the external Id parameter into a long value, to find the link segment type when link segment type objects use long values for external ids.
getMaximumDensity(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the flow density of the current link
getMaximumDensityPerLane() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getMaximumDensityPerLane() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
getMaximumDensityPerLane() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return the maximum density per lane for this macroscopic link segment type
getMaximumSpeed(LinkSegment, Mode) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the maximum speed through the current link segment
getMaximumSpeed(Mode) - Method in class org.planit.network.physical.LinkSegmentImpl
Return the maximum speed along this link for a specified mode
getMaximumSpeed(Mode) - Method in interface org.planit.utils.network.physical.LinkSegment
Return the maximum speed along this link for a specified mode
getMaxIterations() - Method in class org.planit.gap.StopCriterion
Return the maximum allowable number of iterations
getMaxSpeed() - Method in class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
 
getMaxSpeed() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicModeProperties
Collect the maximum speed in km/h
getModalLinkSegmentCosts(Mode) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Retrieve the link segment costs for a specified mode
getModalNetworkSegmentFlows(Mode) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Get the flows for a specified mode
getModalNetworkSegmentFlows(Mode) - Method in interface org.planit.interactor.LinkVolumeAccessee
Get link segment flows for a specified mode
getModalNetworkSegmentFlows(Mode) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
#Get link segment flows for a specified mode
getMode() - Method in class org.planit.userclass.UserClass
Return the mode of travel of this user class
getModeByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return Mode for a specified external Id
getModeByExternalId(Object) - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Retrieve a Mode by its external Id This method is not efficient, since it loops through all the registered modes in order to find the required time period.
getModeByExternalId(Object, boolean) - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Retrieve a Mode by its external Id This method has the option to convert the external Id parameter into a long value, to find the mode when mode objects use long values for external ids.
getModeById(long) - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Return a Mode by its id
getModeExternalId(Mode) - Static method in class org.planit.output.property.ModeExternalIdOutputProperty
Returns the external Id of the current mode
getModeId(Mode) - Static method in class org.planit.output.property.ModeIdOutputProperty
Returns the Id of the current mode
getModeProperties(Mode) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Returns the mode properties for a specified mode along this link
getModeProperties(Mode) - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Returns the mode properties for a specified mode along this link
getModePropertiesMap() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getModeSpecificData() - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Collect the data per mode for all modes
getMultiplier() - Method in enum org.planit.output.enums.OutputTimeUnit
 
getName() - Method in class org.planit.graph.EdgeImpl
collect the name of the edge
getName() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getName() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
getName() - Method in class org.planit.network.physical.ModeImpl
 
getName() - Method in class org.planit.output.property.BaseOutputProperty
Returns the name of the output property
getName() - Method in class org.planit.output.property.CalculatedSpeedOutputProperty
 
getName() - Method in class org.planit.output.property.CapacityPerLaneOutputProperty
 
getName() - Method in class org.planit.output.property.CostTimesFlowOutputProperty
 
getName() - Method in class org.planit.output.property.DensityOutputProperty
 
getName() - Method in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.DestinationZoneIdOutputProperty
 
getName() - Method in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
getName() - Method in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
getName() - Method in class org.planit.output.property.FlowOutputProperty
 
getName() - Method in class org.planit.output.property.IterationIndexOutputProperty
 
getName() - Method in class org.planit.output.property.LengthOutputProperty
 
getName() - Method in class org.planit.output.property.LinkCostOutputProperty
 
getName() - Method in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.LinkSegmentIdOutputProperty
 
getName() - Method in class org.planit.output.property.LinkTypeOutputProperty
 
getName() - Method in class org.planit.output.property.MaximumDensityOutputProperty
 
getName() - Method in class org.planit.output.property.MaximumSpeedOutputProperty
 
getName() - Method in class org.planit.output.property.ModeExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.ModeIdOutputProperty
 
getName() - Method in class org.planit.output.property.NumberOfLanesOutputProperty
 
getName() - Method in class org.planit.output.property.ODCostOutputProperty
 
getName() - Method in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.OriginZoneIdOutputProperty
 
getName() - Method in class org.planit.output.property.PathIdOutputProperty
 
getName() - Method in class org.planit.output.property.PathOutputStringProperty
 
getName() - Method in class org.planit.output.property.RunIdOutputProperty
 
getName() - Method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.TimePeriodIdOutputProperty
 
getName() - Method in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
getName() - Method in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
getName() - Method in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
getName() - Method in class org.planit.output.property.VCRatioOutputProperty
 
getName() - Method in class org.planit.userclass.TravelerType
 
getName() - Method in class org.planit.userclass.UserClass
Get the name of this user class
getName() - Method in interface org.planit.utils.graph.Edge
collect the name of the edge
getName() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return the name of this macroscopic link segment type
getName() - Method in interface org.planit.utils.network.physical.Mode
Name of this mode
getNetwork() - Method in class org.planit.io.project.PlanItSimpleProject
Return the current network object
getNetworkIdGroupingToken() - Method in class org.planit.network.physical.PhysicalNetwork
Collect the id grouping token used for all entities registered on the network, i.e., this network's specific identifier for generating ids unique and contiguous within this network and this network only
getNodeByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return a node for a specified external Id
getNodeById(long) - Method in class org.planit.network.physical.PhysicalNetwork.Nodes
Find a node by its d
getNodeId() - Method in class org.planit.network.physical.NodeImpl
Collect the id of the node.
getNodeId() - Method in interface org.planit.utils.network.physical.Node
Collect the id of the node.
getNumberOfCentroids() - Method in class org.planit.network.virtual.VirtualNetwork.Centroids
Return number of registered centroids
getNumberOfConnectoids() - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Return number of connectoids on the network
getNumberOfConnectoidSegments() - Method in class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
Return the number of registered connectoid segments
getNumberOfDemands() - Method in class org.planit.project.PlanItProjectInput.ProjectDemands
Get the number of demands
getNumberOfEdges() - Method in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
#Number of entries in edge segments
getNumberOfEdges() - Method in interface org.planit.utils.graph.Vertex.EdgeSegments
Number of entries in edge segments
getNumberOfIncomingLinkSegments() - Method in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
Collect number of incoming link segments
getNumberOfLanes() - Method in class org.planit.network.physical.LinkSegmentImpl
 
getNumberOfLanes() - Method in interface org.planit.utils.network.physical.LinkSegment
Collect the number of lanes of this segment
getNumberOfLanes(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the number of lanes of the current link
getNumberOfLinks() - Method in class org.planit.network.physical.PhysicalNetwork.Links
Get the number of links on the network
getNumberOfLinkSegments() - Method in interface org.planit.interactor.LinkVolumeAccessee
Get number of link segments
getNumberOfLinkSegments() - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Return number of registered link segments
getNumberOfLinkSegments() - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
#Get number of link segments
getNumberOfModes() - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Return number of registered modes
getNumberOfNodes() - Method in class org.planit.network.physical.PhysicalNetwork.Nodes
Return number of registered nodes
getNumberOfOdRouteSets() - Method in class org.planit.route.ODRouteSets
Collect the number of registered od route sets
getNumberOfODRouteSets() - Method in class org.planit.project.PlanItProjectInput.ProjectODRouteSets
Get the number of od route sets
getNumberOfOutgoingLinkSegments() - Method in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
Collect number of outgoing link segments
getNumberOfPhysicalNetworks() - Method in class org.planit.project.PlanItProjectInput.ProjectNetworks
Get the number of networks
getNumberOfRegisteredTimePeriods() - Method in class org.planit.input.InputBuilderListener
Returns the number of registered time periods
getNumberOfTimePeriods() - Method in class org.planit.demands.Demands.TimePeriods
Collect the number of registered time periods
getNumberOfTrafficAssignments() - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
Get the number of traffic assignment
getNumberOfTravelAnalysisZones() - Method in interface org.planit.od.ODData
Returns the number of zones contained in the object
getNumberOfTravelAnalysisZones() - Method in class org.planit.od.ODDataImpl
Returns the number of zones contained in the object
getNumberOfTravelerTypes() - Method in class org.planit.demands.Demands.TravelerTypes
Collect the number of registered traveler types
getNumberOfUserClasses() - Method in class org.planit.demands.Demands.UserClasses
Collect the number of registered user classes
getNumberOfZones() - Method in class org.planit.network.virtual.Zoning.Zones
Collect number of zones on the zoning
getNumberOfZonings() - Method in class org.planit.project.PlanItProjectInput.ProjectZonings
Get the number of zonings
getODCost(ODMatrixIterator, double) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the OD travel cost for the current cell in the OD skim matrix
getODOutputPropertyValue(OutputProperty, ODMatrixIterator, Mode, TimePeriod, double) - Method in interface org.planit.output.adapter.ODOutputTypeAdapter
Returns the specified output property values for the current cell in the OD Matrix Iterator
getODOutputPropertyValue(OutputProperty, ODMatrixIterator, Mode, TimePeriod, double) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the specified output property values for the current cell in the OD Matrix Iterator
getODPathMatrix(Mode) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Retrieve the current OD path for a specified mode
getODPathMatrix(Mode) - Method in interface org.planit.output.adapter.RouteOutputTypeAdapter
Retrieve an OD path matrix object for a specified mode
getODPathMatrix(Mode) - Method in class org.planit.output.adapter.TraditionalStaticRouteOutputTypeAdapter
Retrieve an OD path matrix object for a specified mode
getODRouteSets(long) - Method in class org.planit.project.PlanItProjectInput.ProjectODRouteSets
Get od rotue sets by id
getODSkimMatrix(ODSkimSubOutputType, Mode) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Retrieve the skim matrix for a specified mode and skim output type
getODSkimMatrix(ODSkimSubOutputType, Mode) - Method in interface org.planit.output.adapter.ODOutputTypeAdapter
Retrieve an OD skim matrix for a specified OD skim output type and mode
getODSkimMatrix(ODSkimSubOutputType, Mode) - Method in class org.planit.output.adapter.TraditionalStaticAssignmentODOutputTypeAdapter
Retrieve an OD skim matrix for a specified OD skim output type and mode
getOdSkimOutputType() - Method in class org.planit.od.odmatrix.skim.ODSkimMatrix
Returns the type of the current OD skim matrix
getOppositeBoundaryLocation() - Method in class org.planit.ltm.LinkSegmentBoundary
collect the opposite location of this boundary.
getOriginZoneExternalId(ODMatrixIterator) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the origin zone external Id for the current cell in the OD skim matrix
getOriginZoneExternalId(ODRouteIterator) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the origin zone external Id for the current cell in the OD path matrix
getOriginZoneId(ODMatrixIterator) - Method in class org.planit.output.adapter.ODOutputTypeAdapterImpl
Returns the origin zone Id for the current cell in the OD skim matrix
getOriginZoneId(ODRouteIterator) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the origin zone Id for the current cell in the OD path matrix
getOutputConfiguration() - Method in class org.planit.output.OutputManager
Get the OutputConfiguration object
getOutputConfiguration() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Provide the output configuration for user access
getOutputConfiguration() - Method in class org.planit.trafficassignment.TrafficAssignment
Provide the output configuration for user access (via the output manager)
getOutputDataValue(Mode, TimePeriod, Integer, OutputType, OutputProperty, Object[]) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Get a specified data value
getOutputFormatter(long) - Method in class org.planit.project.CustomPlanItProject
Retrieve an output formatter object given its id
getOutputFormatters() - Method in class org.planit.output.OutputManager
Returns the list of currently registered OutputFormatter objects for a specified output type
getOutputFormatters() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Returns a list of output formatters registered on this assignment
getOutputFormatters() - Method in class org.planit.trafficassignment.TrafficAssignment
Returns a list of output formatters registered on this assignment
getOutputKeyProperties() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Returns an array of output properties for keys used in MemoryOutputFormatter The output array can only contain output properties which are of ID_PRIORITY
getOutputKeyProperties(OutputType) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns the array of output properties representing the output types of the keys for the current output type
getOutputProperties() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Returns the current set of output properties for this output configuration
getOutputProperty() - Method in class org.planit.output.property.BaseOutputProperty
Return the value of the OutputProperty enumeration for this property
getOutputProperty() - Method in class org.planit.output.property.CalculatedSpeedOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.CapacityPerLaneOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.CostTimesFlowOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DensityOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DestinationZoneIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.FlowOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.IterationIndexOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.LengthOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.LinkCostOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.LinkSegmentIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.LinkTypeOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.MaximumDensityOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.MaximumSpeedOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.ModeExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.ModeIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.NumberOfLanesOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.ODCostOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.OriginZoneIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.PathIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.PathOutputStringProperty
 
getOutputProperty() - Method in class org.planit.output.property.RunIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.TimePeriodIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
getOutputProperty() - Method in class org.planit.output.property.VCRatioOutputProperty
 
getOutputTimeUnit() - Method in class org.planit.output.formatter.BaseOutputFormatter
Returns the current time units
getOutputTimeUnitString() - Method in class org.planit.output.formatter.BaseOutputFormatter
Returns the current time units as a String
getOutputType() - Method in interface org.planit.output.adapter.OutputTypeAdapter
Return the output type corresponding to this output adapter
getOutputType() - Method in class org.planit.output.adapter.OutputTypeAdapterImpl
Return the output type corresponding to this output adapter
getOutputType() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Returns the OutputAdapter being used for this configuration
getOutputTypeAdapter(OutputType) - Method in class org.planit.output.adapter.OutputAdapter
Retrieve an output type adapter for a specified output type
getOutputTypeConfiguration(OutputType) - Method in class org.planit.output.OutputManager
Collect the output type configuration for the given type
getOutputValueProperties() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Returns an array of output properties for values used in MemoryOutputFormatter The output array can only contain output properties which are not of ID_PRIORITY
getOutputValueProperties(OutputType) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns the array of output properties representing the output types of the data values for the current output type
getParameterTypes(Object[]) - Static method in class org.planit.utils.reflection.ReflectionUtils
Method that constructs the parameter types that go with the passed in parameters.
getParentEdge() - Method in class org.planit.graph.EdgeSegmentImpl
parent edge of the segment
getParentEdge() - Method in interface org.planit.utils.graph.EdgeSegment
Collect the parent edge of the segment
getParentLink() - Method in class org.planit.network.physical.LinkSegmentImpl
Return the parent link of this link segment
getParentLink() - Method in interface org.planit.utils.network.physical.LinkSegment
Return the parent link of this link segment
getParentZone() - Method in class org.planit.network.virtual.CentroidImpl
Return the parent zone of this centroid
getParentZone() - Method in interface org.planit.utils.network.virtual.Centroid
Return the parent zone of this centroid
getPath() - Method in interface org.planit.route.Route
Return the route as a List of EdgeSegments
getPath() - Method in class org.planit.route.RouteImpl
Return the route as a List of EdgeSegments
getPathIdType() - Method in class org.planit.output.configuration.PathOutputTypeConfiguration
Get the path id type
getPcu() - Method in class org.planit.network.physical.ModeImpl
 
getPcu() - Method in interface org.planit.utils.network.physical.Mode
Passenger car unit conversion factor for this mode
getPcuFowRatePerHour() - Method in class org.planit.ltm.event.ReleaseFlowEvent
 
getPcuFowRatePerHour() - Method in class org.planit.ltm.event.TriggerFlowEvent
 
getPhysicalCost() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Collect the physical cost entity registered on the traffic assignment
getPhysicalCost() - Method in class org.planit.trafficassignment.TrafficAssignment
Get the dynamic physical cost object for the current assignment
getPhysicalCostClassName() - Method in class org.planit.output.adapter.OutputAdapter
Returns the name of the physical cost class
getPhysicalLinkSegments() - Method in interface org.planit.output.adapter.LinkOutputTypeAdapter
Return a Link segments for this assignment
getPhysicalLinkSegments() - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Provide access to the available link segments
getPhysicalNetwork() - Method in class org.planit.network.transport.TransportNetwork
Collect the physical network component of the transport network
getPhysicalNetwork(long) - Method in class org.planit.project.PlanItProjectInput.ProjectNetworks
Get physical network by id
getPositionOfOutputKeyProperty(OutputType, OutputProperty) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns the position of a property type in the output key property array
getPositionOfOutputKeyProperty(OutputProperty) - Method in class org.planit.data.MultiKeyPlanItData
Get the position of a property type in the output keys property array
getPositionOfOutputValueProperty(OutputType, OutputProperty) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Returns the position of a property type in the output values property array
getPositionOfOutputValueProperty(OutputProperty) - Method in class org.planit.data.MultiKeyPlanItData
Get the position of a property type in the output values property array
getReferenceTimeInSeconds() - Method in interface org.planit.utils.cumulatives.CumulativePoint
 
getReferenceTimeInSeconds() - Method in class org.planit.utils.cumulatives.CumulativePointImpl
 
getRegisteredModesForTimePeriod(TimePeriod) - Method in class org.planit.demands.Demands
Get modes registered for the given time period
getRegisteredOutputTypeConfigurations() - Method in class org.planit.output.OutputManager
Returns a List of registered output type configuration objects
getRegisteredOutputTypes() - Method in class org.planit.output.OutputManager
Returns a List of registered output types
getRequestedAccesseeEventType() - Method in interface org.planit.interactor.InteractorAccessor
each interactor that requires access from an accessee indicates what accessee is requested via the event type
getRequestedAccesseeEventType() - Method in interface org.planit.interactor.LinkVolumeAccessor
each interactor that requires access from an accessee indicates what accessee is requested via the event type
getRouteAsString(ODRouteIterator, RouteIdType) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the path as a String of comma-separated Id values
getRouteId(ODRouteIterator) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Return the Id of the current path If there is no path between the current origin and destination zones, this returns -1
getRouteOutputPropertyValue(OutputProperty, ODRouteIterator, Mode, TimePeriod, RouteIdType) - Method in interface org.planit.output.adapter.RouteOutputTypeAdapter
Returns the specified output property values for the current cell in the ODPathIterator
getRouteOutputPropertyValue(OutputProperty, ODRouteIterator, Mode, TimePeriod, RouteIdType) - Method in class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Returns the specified output property values for the current cell in the ODPathIterator
getRowValue(OutputProperty, Object...) - Method in class org.planit.data.MultiKeyPlanItData
Get data value for a specified row and column
getRowValues(Object...) - Method in class org.planit.data.MultiKeyPlanItData
Returns an array representing the row of data values defined by the specified array of key values
getRunId() - Method in class org.planit.output.adapter.OutputAdapter
Return the id of this assignment run
getRunId(TrafficAssignment) - Static method in class org.planit.output.property.RunIdOutputProperty
Returns the current run id
getSecond() - Method in class org.planit.utils.misc.Pair
Get second object in pair
getSegmentCost(Mode, LinkSegment) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Return the travel time for the current link for a given mode If the input data are invalid, this method returns a negative value.
getSegmentCost(Mode, LinkSegment) - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Returns the initial cost for each link segment and mode
getSegmentCost(Mode, ConnectoidSegment) - Method in class org.planit.cost.virtual.FixedConnectoidTravelTimeCost
Calculates the connectoid segment cost using a fixed travel time
getSegmentCost(Mode, ConnectoidSegment) - Method in class org.planit.cost.virtual.SpeedConnectoidTravelTimeCost
Return the connectoid travel time using speed
getSegmentCost(Mode, T) - Method in interface org.planit.cost.Cost
Returns the cost of travel along an edge segment for a specified mode
getSimulationData() - Method in class org.planit.ltm.trafficassignment.ELTM
Return the simulation data for the current iteration
getSimulationData() - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
Return the simulation data for the current iteration
getSimulationData() - Method in class org.planit.trafficassignment.TrafficAssignment
Return the simulation data for the current iteration
getSkimMatrixMap(Mode) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Retrieve the Map of OD Skim matrices for all active OD Skim Output Types for a specified mode
getSmoothing() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Collect the smoothing entity registered on the traffic assignment
getSmoothing() - Method in class org.planit.trafficassignment.TrafficAssignment
Collect the smoothing object for the current traffic assignment
getSmoothingClassName() - Method in class org.planit.output.adapter.OutputAdapter
Return the name of the smoothing class
getSourceId() - Method in class org.planit.trafficassignment.TrafficAssignmentComponent
the source id whenever this instance fires an event is simply this
getSourceId() - Method in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
sourceId provides information of the source of an event fired from this class instance
getSourceTriggerEvent() - Method in class org.planit.ltm.event.ReleaseEvent
Collect the source trigger event that is the cause of this release event being scheduled
getSpeed() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Return the travel speed for this link
getSpeedMap() - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
getStackFramesAsList() - Static method in class org.planit.utils.reflection.StackWalkerUtil
collect the current stack frames as a list
getStackFrameWithOffset(int) - Static method in class org.planit.utils.reflection.StackWalkerUtil
Skip any number of stack frames and return the stream at this offset point
getStartNodeId() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Return the id of the start nonde
getStartTimeSeconds() - Method in class org.planit.time.TimePeriod
Return the start time
getStopCriterion() - Method in class org.planit.gap.GapFunction
Return the StopCriterion object
getStopCriterionClassName() - Method in class org.planit.output.adapter.OutputAdapter
Return the name of the stopping criterion class
getTimePeriod() - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCostPeriod
 
getTimePeriodByExternalId(Object) - Method in class org.planit.demands.Demands.TimePeriods
Retrieve a TimePeriod by its external Id This method is not efficient, since it loops through all the registered time periods in order to find the required time period.
getTimePeriodByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return the time period for a specified external Id
getTimePeriodByExternalId(Object, boolean) - Method in class org.planit.demands.Demands.TimePeriods
Retrieve a TimePeriod by its external Id This method has the option to convert the external Id parameter into a long value, to find the time period when time period objects use long values for external ids.
getTimePeriodById(long) - Method in class org.planit.demands.Demands.TimePeriods
Retrieve a time period by its id
getTimePeriodExternalId(TimePeriod) - Static method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
Returns the current time period external Id
getTimePeriodExternalIds() - Method in class org.planit.input.InputBuilderListener
Returns a list of external ids of time periods
getTimePeriodExternalIds() - Method in class org.planit.io.project.PlanItSimpleProject
Retrieve a list of the external Ids of all registered time periods
getTimePeriodId(TimePeriod) - Static method in class org.planit.output.property.TimePeriodIdOutputProperty
Returns the current time period Id
getTotalNetworkSegmentFlow(LinkSegment) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Return the total flow through a link segment across all modes
getTotalNetworkSegmentFlow(LinkSegment) - Method in interface org.planit.interactor.LinkVolumeAccessee
Get the total flow across a link over all modes
getTotalNetworkSegmentFlow(LinkSegment) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
#Get the total flow across a link over all modes
getTotalNumberOfConnectoidSegments() - Method in class org.planit.network.transport.TransportNetwork
Returns the total number of connectoid segments available in this transport network
getTotalNumberOfEdgeSegments() - Method in class org.planit.network.transport.TransportNetwork
Returns the total number of edge segments available in this traffic assignment by combining the physical and non-physical link segments
getTotalNumberOfPhysicalLinkSegments() - Method in class org.planit.network.transport.TransportNetwork
Returns the total number of link segments available in this transport network
getTotalNumberOfVertices() - Method in class org.planit.network.transport.TransportNetwork
Returns the total number of virtual and physical vertices in this transport network
getTrafficAssignment(long) - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
Get traffic assignment by id
getTrafficComponentType() - Method in class org.planit.trafficassignment.TrafficAssignmentComponent
 
getTransportNetwork() - Method in class org.planit.trafficassignment.TrafficAssignment
Get the TransportNetwork used in the current assignment
getTravelerType() - Method in class org.planit.userclass.UserClass
Get the traveler type of this user class
getTravelerTypeByExternalId(Object) - Method in class org.planit.demands.Demands.TravelerTypes
Retrieve a TravelerType by its external Id This method is not efficient, since it loops through all the registered traveler type in order to find the required entry.
getTravelerTypeByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return traveler type for a specified external Id
getTravelerTypeByExternalId(Object, boolean) - Method in class org.planit.demands.Demands.TravelerTypes
Retrieve a TravelerType by its external Id This method has the option to convert the external Id parameter into a long value, to find the traveler type when using long values for external ids.
getTravelerTypeById(long) - Method in class org.planit.demands.Demands.TravelerTypes
Retrieve a traveler type by its id
getType() - Method in class org.planit.output.property.BaseOutputProperty
Returns the data type of the output property
getType() - Method in class org.planit.output.property.CalculatedSpeedOutputProperty
 
getType() - Method in class org.planit.output.property.CapacityPerLaneOutputProperty
 
getType() - Method in class org.planit.output.property.CostTimesFlowOutputProperty
 
getType() - Method in class org.planit.output.property.DensityOutputProperty
 
getType() - Method in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.DestinationZoneIdOutputProperty
 
getType() - Method in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
getType() - Method in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
getType() - Method in class org.planit.output.property.FlowOutputProperty
 
getType() - Method in class org.planit.output.property.IterationIndexOutputProperty
 
getType() - Method in class org.planit.output.property.LengthOutputProperty
 
getType() - Method in class org.planit.output.property.LinkCostOutputProperty
 
getType() - Method in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.LinkSegmentIdOutputProperty
 
getType() - Method in class org.planit.output.property.LinkTypeOutputProperty
 
getType() - Method in class org.planit.output.property.MaximumDensityOutputProperty
 
getType() - Method in class org.planit.output.property.MaximumSpeedOutputProperty
 
getType() - Method in class org.planit.output.property.ModeExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.ModeIdOutputProperty
 
getType() - Method in class org.planit.output.property.NumberOfLanesOutputProperty
 
getType() - Method in class org.planit.output.property.ODCostOutputProperty
 
getType() - Method in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.OriginZoneIdOutputProperty
 
getType() - Method in class org.planit.output.property.PathIdOutputProperty
 
getType() - Method in class org.planit.output.property.PathOutputStringProperty
 
getType() - Method in class org.planit.output.property.RunIdOutputProperty
 
getType() - Method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.TimePeriodIdOutputProperty
 
getType() - Method in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
getType() - Method in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
getType() - Method in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
getType() - Method in class org.planit.output.property.VCRatioOutputProperty
 
getUnits() - Method in class org.planit.output.property.BaseOutputProperty
Returns the units of the output property
getUnits() - Method in class org.planit.output.property.CalculatedSpeedOutputProperty
 
getUnits() - Method in class org.planit.output.property.CapacityPerLaneOutputProperty
 
getUnits() - Method in class org.planit.output.property.CostTimesFlowOutputProperty
 
getUnits() - Method in class org.planit.output.property.DensityOutputProperty
 
getUnits() - Method in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.DestinationZoneIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
getUnits() - Method in class org.planit.output.property.FlowOutputProperty
 
getUnits() - Method in class org.planit.output.property.IterationIndexOutputProperty
 
getUnits() - Method in class org.planit.output.property.LengthOutputProperty
 
getUnits() - Method in class org.planit.output.property.LinkCostOutputProperty
 
getUnits() - Method in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.LinkSegmentIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.LinkTypeOutputProperty
 
getUnits() - Method in class org.planit.output.property.MaximumDensityOutputProperty
 
getUnits() - Method in class org.planit.output.property.MaximumSpeedOutputProperty
 
getUnits() - Method in class org.planit.output.property.ModeExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.ModeIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.NumberOfLanesOutputProperty
 
getUnits() - Method in class org.planit.output.property.ODCostOutputProperty
 
getUnits() - Method in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.OriginZoneIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.PathIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.PathOutputStringProperty
 
getUnits() - Method in class org.planit.output.property.RunIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.TimePeriodIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
getUnits() - Method in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
getUnits() - Method in class org.planit.output.property.VCRatioOutputProperty
 
getUpstreamNodeExternalId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the external Id of the upstream node
getUpstreamNodeId(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the Id of the upstream node
getUpstreamNodeLocation(LinkSegment) - Method in class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Returns the location of the upstream node
getUpstreamVertex() - Method in class org.planit.graph.EdgeSegmentImpl
Get the segment's upstream vertex
getUpstreamVertex() - Method in interface org.planit.utils.graph.EdgeSegment
Get the segment's upstream vertex
getUserClassByExternalId(Object) - Method in class org.planit.demands.Demands.UserClasses
Retrieve a UserClass by its external Id This method is not efficient, since it loops through all the registered user classes in order to find the required entry.
getUserClassByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Return user class by external Id
getUserClassByExternalId(Object, boolean) - Method in class org.planit.demands.Demands.UserClasses
Retrieve a UserClass by its external Id This method has the option to convert the external Id parameter into a long value, to find the user class when using long values for external ids.
getUserClassById(long) - Method in class org.planit.demands.Demands.UserClasses
Retrieve a user class by its id
getValue(Zone, Zone) - Method in interface org.planit.od.ODData
Returns the value for a specified origin and destination
getValue(Zone, Zone) - Method in class org.planit.od.odmatrix.ODMatrix
Returns the value for a specified origin and destination
getValue(Zone, Zone) - Method in class org.planit.od.odroute.ODRouteMatrix
Returns the path for a specified origin and destination
getValues() - Method in interface org.planit.data.MultiKeyPlanItDataIterator
Returns an array of values for the current iteration
getValues() - Method in class org.planit.data.MultiKeyPlanItDataIteratorImpl
Returns an array of values for the current iteration
getValues() - Method in class org.planit.output.formatter.MemoryOutputIterator
Returns an array of values for the current iteration
getVertexA() - Method in class org.planit.graph.EdgeImpl
Vertex A of the edge
getVertexA() - Method in interface org.planit.utils.graph.Edge
Vertex A of the edge
getVertexB() - Method in class org.planit.graph.EdgeImpl
Vertex B of the edge
getVertexB() - Method in interface org.planit.utils.graph.Edge
Vertex B of the edge
getVirtualCost() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Collect the virtual cost entity registered on the traffic assignment
getVirtualCost() - Method in class org.planit.trafficassignment.TrafficAssignment
Returns the virtual cost object for the current assignment
getVirtualCostClassName() - Method in class org.planit.output.adapter.OutputAdapter
Return the name of the virtual cost class
getVirtualNetwork() - Method in class org.planit.network.transport.TransportNetwork
Collect the virtual network component of the transport network
getVirtualNetwork() - Method in class org.planit.network.virtual.Zoning
Get the virtual network for this zoning
getXmlFileName(OutputType) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Returns the XML output file name for a specified output type
getXmlFileName(OutputType) - Method in interface org.planit.output.formatter.XmlTextFileOutputFormatter
Returns the XML output file name for a specified output type
getZoneByExternalId(Object) - Method in class org.planit.input.InputBuilderListener
Returns the zone for a specified external Id
getZoneById(long) - Method in class org.planit.network.virtual.Zoning.Zones
Retrieve zone by its Id
getZoning() - Method in class org.planit.io.project.PlanItSimpleProject
Return the current Zoning object
getZoning() - Method in class org.planit.network.transport.TransportNetwork
Collect the zoning structure
getZoning(long) - Method in class org.planit.project.PlanItProjectInput.ProjectZonings
Get zoning by id
groupId - Variable in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Contiguous id generation within this group id token for all instances created with factory methods in this class
groupId - Variable in class org.planit.network.virtual.VirtualNetwork
Contiguous id generation within this group id token for all instances created with factory methods in this class
groupId - Variable in class org.planit.trafficassignment.TrafficAssignmentComponent
id generation using this token will be contiguous and unique for each instance of this class

H

H - org.planit.output.enums.Units
 
hasActiveSubOutputTypes() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Indicates if sub output types are present or not
hasConverged(double, int) - Method in class org.planit.gap.StopCriterion
Check if converged based on the gap and the internal information
hasConverged(int) - Method in class org.planit.gap.GapFunction
Verify if algorithm has converged
hasExternalId() - Method in class org.planit.graph.EdgeSegmentImpl
Does the instance have an external id
hasExternalId() - Method in class org.planit.network.physical.LinkImpl
 
hasExternalId() - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
hasExternalId() - Method in class org.planit.network.physical.ModeImpl
 
hasExternalId() - Method in class org.planit.network.physical.NodeImpl
Returns whether the node has an external Id set
hasExternalId() - Method in class org.planit.network.virtual.ConnectoidImpl
 
hasExternalId() - Method in class org.planit.network.virtual.ZoneImpl
 
hasExternalId() - Method in class org.planit.time.TimePeriod
Returns whether this time period has its external id set
hasExternalId() - Method in class org.planit.userclass.TravelerType
 
hasExternalId() - Method in class org.planit.userclass.UserClass
 
hasExternalId() - Method in interface org.planit.utils.graph.EdgeSegment
Does the instance have an external id
hasExternalId() - Method in interface org.planit.utils.network.physical.Link
Returns whether the external Id has been set
hasExternalId() - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Return whether this link segment type has an external Id
hasExternalId() - Method in interface org.planit.utils.network.physical.Mode
Returns whether this mode has an external Id set
hasExternalId() - Method in interface org.planit.utils.network.physical.Node
Returns whether the node has an external Id set
hasExternalId() - Method in interface org.planit.utils.network.virtual.Connectoid
Returns true if this connectoid has its external Id set, false otherwise
hasExternalId() - Method in interface org.planit.utils.network.virtual.Zone
Returns whether this zone has its external Id set
hashCode() - Method in class org.planit.output.property.BaseOutputProperty
Overridden hashCode() method This method is needed to allow output properties to be removed from the output list if required.
hashCode() - Method in class org.planit.utils.misc.Pair
 
hashCode() - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Return the hashCode for this object
hasNext() - Method in interface org.planit.data.MultiKeyPlanItDataIterator
Returns whether the MultiKeyPlanItData has any more rows
hasNext() - Method in class org.planit.data.MultiKeyPlanItDataIteratorImpl
Returns whether the MultiKeyPlanItData has any more rows
hasNext() - Method in class org.planit.od.ODDataIteratorImpl
Tests whether there are any more cells to iterate through
hasNext() - Method in class org.planit.output.formatter.MemoryOutputIterator
Returns whether the MemoryOutputFormatter has any more rows
hasRegisteredAssignments() - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
Check if assignments have already been registered
hasRegisteredDemands() - Method in class org.planit.project.PlanItProjectInput.ProjectDemands
Check if demands have already been registered
hasRegisteredNetworks() - Method in class org.planit.project.PlanItProjectInput.ProjectNetworks
Check if networks have already been registered
hasRegisteredOdMatrices() - Method in class org.planit.route.ODRouteSets
verify if any od route matrices have been registered or not
hasRegisteredODRouteSets() - Method in class org.planit.project.PlanItProjectInput.ProjectODRouteSets
Check if od route sets have already been registered
hasRegisteredZonings() - Method in class org.planit.project.PlanItProjectInput.ProjectZonings
Check if zonings have already been registered
HOURS - org.planit.output.enums.OutputTimeUnit
 

I

id - Variable in class org.planit.graph.EdgeImpl
Unique internal identifier
id - Variable in class org.planit.graph.EdgeSegmentImpl
unique internal identifier
id - Variable in class org.planit.graph.VertexImpl
Unique internal identifier
id - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Unique segment type id
id - Variable in class org.planit.network.virtual.ZoneImpl
Unique identifier for the zone
id - Variable in class org.planit.od.odroute.ODRouteMatrix
Unique identifier
id - Variable in class org.planit.output.formatter.BaseOutputFormatter
Unique internal id of the output writer
id - Variable in class org.planit.project.CustomPlanItProject
unique identifier for this project across all projects in the JVM
id - Variable in class org.planit.trafficassignment.TrafficAssignmentComponent
unique identifier for this traffic component
ID_PRIORITY - org.planit.output.property.OutputPropertyPriority
 
IdGenerator - Class in org.planit.utils.id
Convenience class to track unique ids across different classes that decide to use a generator for their id members.
IdGenerator() - Constructor for class org.planit.utils.id.IdGenerator
 
IdGroupingToken - Class in org.planit.utils.id
Class used as token to group ids, i.e., ids for a class generated with this token will be unique within this group.
IdGroupingToken(String) - Constructor for class org.planit.utils.id.IdGroupingToken
Constructor
incomingLinkSegmentCapacities - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
store the capacities of each incoming link segment, i.e., C_a
incomingLinkSegmentFlowAcceptanceFactors - Variable in class org.planit.algorithms.nodemodel.TampereNodeModel
the result of the node model are the acceptance factors for each incoming link segment
incomingLinkSegments - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
mapping of incoming link index to link segment (if any), i.e., a=1,...|A^in|-1
increaseActualSystemTravelTime(double) - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Increase system travel time, i.e.
increaseConvexityBound(double) - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Increase convexity bound travel time, i.e.
incrementIterationIndex() - Method in class org.planit.data.SimulationData
Increment iteration index by one
initialCostsLocation - Variable in class org.planit.output.formatter.BaseOutputFormatter
The location of the initial costs files
initialiseBeforeExecution() - Method in class org.planit.trafficassignment.TrafficAssignment
Initialize all relevant traffic assignment components before execution of the assignment commences
initialiseBeforeSimulation(long) - Method in class org.planit.output.OutputManager
Allows the output manager to initialize itself and any of its registered output formatters to prepare before the simulation starts
initialiseBeforeSimulation(Map<OutputType, OutputTypeConfiguration>, long) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Create the output directories and open the CSV writers
initialiseBeforeSimulation(Map<OutputType, OutputTypeConfiguration>, long) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Opens all resources used in the formatter
initialiseBeforeSimulation(Map<OutputType, OutputTypeConfiguration>, long) - Method in interface org.planit.output.formatter.OutputFormatter
Open resources to store results
initialiseBeforeSimulation(PhysicalNetwork) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Register the BPR cost parameter values on the PhysicalNetwork Call this method after all the calls to set the cost parameters have been made
initialiseBeforeSimulation(PhysicalNetwork) - Method in class org.planit.cost.physical.PhysicalCost
Initialize the cost parameter values in the network
initialiseBeforeSimulation(VirtualNetwork) - Method in class org.planit.cost.virtual.FixedConnectoidTravelTimeCost
Initialize the virtual cost component
initialiseBeforeSimulation(VirtualNetwork) - Method in class org.planit.cost.virtual.SpeedConnectoidTravelTimeCost
#Initialize the virtual cost component
initialiseBeforeSimulation(VirtualNetwork) - Method in class org.planit.cost.virtual.VirtualCost
Initialize the virtual cost component
initialiseDefaults() - Method in class org.planit.trafficassignment.builder.TraditionalStaticAssignmentBuilder
Traditional static assignment has the following defaults set for it: - PhysicalCost: BPR - Virtualcost: FIXED - Smoothing: MSA - Gapfunction: LinkBasedRelativeDualityGap
initialiseDefaults() - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Initialize the traffic assignment defaults for the activated assignment method:
initialiseFactories() - Method in class org.planit.project.CustomPlanItProject
Instantiate the factories and register the event manager on them
initialiseRun() - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Initialise the run conforming to Step 1 in Appendix A of Bliemer et al.
initialLinkSegmentCost - Variable in class org.planit.trafficassignment.TrafficAssignment
The initial link segment cost
InitialLinkSegmentCost - Class in org.planit.cost.physical.initial
Initial Link Segment Costs stored by mode
InitialLinkSegmentCost(IdGroupingToken) - Constructor for class org.planit.cost.physical.initial.InitialLinkSegmentCost
Constructor
initialLinkSegmentCostByTimePeriod - Variable in class org.planit.trafficassignment.TrafficAssignment
Map storing InitialLinkSegmentCost objects for each time period
InitialLinkSegmentCostPeriod - Class in org.planit.cost.physical.initial
Identical to InitialLinkSegmentCost except that it is directly attached to a particular time period.
InitialLinkSegmentCostPeriod(IdGroupingToken) - Constructor for class org.planit.cost.physical.initial.InitialLinkSegmentCostPeriod
Constructor
initialLinkSegmentCosts - Variable in class org.planit.project.PlanItProjectInput
Map to store all InitialLinkSegmentCost objects for each physical network
InitialPhysicalCost - Class in org.planit.cost.physical.initial
The initial physical costs for the network
InitialPhysicalCost(IdGroupingToken) - Constructor for class org.planit.cost.physical.initial.InitialPhysicalCost
Constructor
initialPhysicalCostFactory - Variable in class org.planit.project.PlanItProjectInput
Object factory for physical costs
INPUT_PRIORITY - org.planit.output.property.OutputPropertyPriority
 
inputBuilderListener - Variable in class org.planit.project.CustomPlanItProject
the listener that we register on each traffic assignment component creation event for external initialization
InputBuilderListener - Class in org.planit.input
Listener which is automatically registered to the creation of any traffic assignment component for which it gets notified.
InputBuilderListener() - Constructor for class org.planit.input.InputBuilderListener
Constructor
inputProperties - Variable in class org.planit.graph.EdgeImpl
Generic input property storage
inputProperties - Variable in class org.planit.graph.VertexImpl
generic input property storage
inputProperties - Variable in class org.planit.network.virtual.ZoneImpl
generic input property storage
inputs - Variable in class org.planit.algorithms.nodemodel.TampereNodeModel
inputs for this node model instance
inputs - Variable in class org.planit.project.CustomPlanItProject
The input container holding all traffic assignment input components and related functionality with respect to project management
INTEGER - org.planit.output.enums.Type
 
integrateConnectoidsAndLinks() - Method in class org.planit.network.transport.TransportNetwork
Integrate physical and virtual links
INTERACTOR_PROVIDE_LINKVOLUMEACCESSEE - Static variable in interface org.planit.interactor.LinkVolumeAccessee
event type fired off when this accessee is identified as a suitable candidate for an accessee request
INTERACTOR_REQUEST_LINKVOLUMEACCESSEE_TYPE - Static variable in interface org.planit.interactor.LinkVolumeAccessor
event type fired off when a new request for an interactor of type link volume accessee is created
InteractorAccessee - Interface in org.planit.interactor
Interactor accessee.
InteractorAccessor - Interface in org.planit.interactor
Interactor accessor.
invoke() - Method in class org.planit.utils.function.NullaryDoubleSupplier
isCompatibleWithDemands(Demands, PhysicalNetwork.Modes) - Method in class org.planit.network.virtual.Zoning
Verify if passed in demands are compatible with the zoning structure.
isCsvDirectorySet() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Returns whether the csv directory has been set
isEarlier(CumulativePoint, double) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Verify if this point occurs earlier (given epsilon) than the passed in other point
isEarlier(CumulativePoint, double) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Verify if this point occurs earlier (given epsilon) than the passed in other point
isEarlierOrEqual(CumulativePoint, double) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Verify if this point occurs earlier or equal (given epsilon) than the passed in other point
isEarlierOrEqual(CumulativePoint, double) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Verify if this point occurs earlier or equal (given epsilon) than the passed in other point
isEmpty() - Method in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
#Test whether no edge segments have been registered
isEmpty() - Method in interface org.planit.utils.graph.Vertex.EdgeSegments
Test whether no edge segments have been registered
isEqual(double, double) - Static method in class org.planit.utils.math.Precision
Compare using a Precision.EPSILON_6
isEqual(double, double, double) - Static method in class org.planit.utils.math.Precision
Compare using a custom precision epsilon
isErrorIfDuplicateExternalId() - Method in class org.planit.input.InputBuilderListener
Return whether input files having duplicate external Ids should be treated as an error
isFlowPositive(LinkSegment, Mode) - Method in interface org.planit.output.adapter.LinkOutputTypeAdapter
Returns true if there is a flow through the current specified link segment for the specified mode
isFlowPositive(LinkSegment, Mode) - Method in class org.planit.output.adapter.TraditionalStaticAssignmentLinkOutputTypeAdapter
Returns true if there is a flow through the current specified link segment for the specified mode
isGreater(double, double) - Static method in class org.planit.utils.math.Precision
isGreater with Precision.EPSILON_6
isGreater(double, double, double) - Static method in class org.planit.utils.math.Precision
isGreaterEqual with epsilon
isGreaterEqual(double, double) - Static method in class org.planit.utils.math.Precision
isGreaterEqual with Precision.EPSILON_6
isGreaterEqual(double, double, double) - Static method in class org.planit.utils.math.Precision
isGreaterEqual with epsilon
isInLinkSegmentProcessed(int) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Verify if in-link segment has been processed already or not
isLater(CumulativePoint, double) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Verify if this point occurs later (given epsilon) than the passed in other point
isLater(CumulativePoint, double) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Verify if this point occurs later (given epsilon) than the passed in other point
isLaterOrEqual(CumulativePoint, double) - Method in interface org.planit.utils.cumulatives.CumulativePoint
Verify if this point occurs later or equal (given epsilon) than the passed in other point
isLaterOrEqual(CumulativePoint, double) - Method in class org.planit.utils.cumulatives.CumulativePointImpl
Verify if this point occurs later or equal (given epsilon) than the passed in other point
isModeAllowedThroughLink(Mode) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
Returns whether vehicles of a specified mode are allowed through this link
isModeAllowedThroughLink(Mode) - Method in interface org.planit.utils.network.physical.LinkSegment
Returns whether vehicles of a specified mode are allowed through this link
isOutputPropertyValid(BaseOutputProperty) - Method in class org.planit.output.configuration.LinkOutputTypeConfiguration
Checks the output property type being added in valid for the current output type configuration
isOutputPropertyValid(BaseOutputProperty) - Method in class org.planit.output.configuration.OriginDestinationOutputTypeConfiguration
Checks the output property type being added in valid for the current output type configuration
isOutputPropertyValid(BaseOutputProperty) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Checks the output property type being added in valid for the current output type configuration
isOutputPropertyValid(BaseOutputProperty) - Method in class org.planit.output.configuration.PathOutputTypeConfiguration
Checks the output property type being added in valid for the current output type configuration
isOutputTypeActive(OutputType) - Method in class org.planit.output.OutputManager
Verify if the given output type is already activated or not
isOutputTypeActive(OutputType) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Verify if a given output type is active
isOutputTypeActive(OutputType) - Method in class org.planit.trafficassignment.TrafficAssignment
Verify if a given output type is active
isPersistOnlyFinalIteration() - Method in class org.planit.output.configuration.OutputConfiguration
Returns whether only the final iteration will be recorded (default is true)
isPersistZeroFlow() - Method in class org.planit.output.configuration.OutputConfiguration
Verify if we are persisting zero flow or not (default is false)
isSegmentCostsSetForMode(Mode) - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Are link segment costs available for the given mode
isSmaller(double, double) - Static method in class org.planit.utils.math.Precision
isSmaller with Precision.EPSILON_6
isSmaller(double, double, double) - Static method in class org.planit.utils.math.Precision
isSmaller with epsilon
isSmallerEqual(double, double) - Static method in class org.planit.utils.math.Precision
isSmallerEqual with Precision.EPSILON_6
isSmallerEqual(double, double, double) - Static method in class org.planit.utils.math.Precision
isSmallerEqual with epsilon
isTimePeriodExternalIdRegistered(Object) - Method in class org.planit.input.InputBuilderListener
Returns whether a time period external Id matches set of external Ids for registered time periods
isXmlDirectorySet() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Returns whether the xml directory has been set
ITERATION_INDEX - org.planit.output.property.OutputProperty
 
IterationIndexOutputProperty - Class in org.planit.output.property
 
IterationIndexOutputProperty() - Constructor for class org.planit.output.property.IterationIndexOutputProperty
 
iterator - Variable in class org.planit.output.formatter.MemoryOutputFormatter
Iterator to loop over results contained in this formatter
iterator() - Method in class org.planit.demands.Demands.TimePeriods
Iterator for time periods (non-sorted)
iterator() - Method in class org.planit.demands.Demands.TravelerTypes
Iterator for traveler types (non-sorted)
iterator() - Method in class org.planit.demands.Demands.UserClasses
Iterator for user classes (non-sorted)
iterator() - Method in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
Iterator over available edge segments
iterator() - Method in class org.planit.network.physical.PhysicalNetwork.Links
Iterator over available links
iterator() - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Iterator over available nodes
iterator() - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Iterator over available modes
iterator() - Method in class org.planit.network.physical.PhysicalNetwork.Nodes
Iterator over available nodes
iterator() - Method in class org.planit.network.virtual.VirtualNetwork.Centroids
Access to all centroids via iterator
iterator() - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Collect the connectoids available through an iterator
iterator() - Method in class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
Iterator for all connectoid segments available
iterator() - Method in class org.planit.network.virtual.Zoning.Zones
Collect iterator for all registered zones (non-ordered)
iterator() - Method in interface org.planit.od.ODData
Returns an iterator which can iterate through all the origin-destination cells
iterator() - Method in class org.planit.od.odmatrix.ODMatrix
Returns an iterator which can iterate through all the origin-destination cells in the matrix
iterator() - Method in class org.planit.od.odroute.ODRouteMatrix
Returns an iterator which can iterate through all the origin-destination cells in the matrix
iterator() - Method in class org.planit.project.CustomPlanItProject.ProjectAssignments
iterable over registered traffic assignments

K

KM - org.planit.output.enums.Units
 
KM_H - org.planit.output.enums.Units
 

L

length - Variable in class org.planit.graph.EdgeImpl
Length of edge
LENGTH - org.planit.output.property.OutputProperty
 
LengthOutputProperty - Class in org.planit.output.property
 
LengthOutputProperty() - Constructor for class org.planit.output.property.LengthOutputProperty
 
Link - Interface in org.planit.utils.network.physical
Link interface which extends the Edge interface with a unique id (not all edges are links) as well as an external id
LINK - org.planit.output.enums.OutputType
 
LINK_COST - org.planit.output.property.OutputProperty
 
LINK_SEGMENT_EXTERNAL_ID - org.planit.output.enums.RouteIdType
 
LINK_SEGMENT_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
LINK_SEGMENT_ID - org.planit.output.enums.RouteIdType
 
LINK_SEGMENT_ID - org.planit.output.property.OutputProperty
 
LINK_TYPE - org.planit.output.property.OutputProperty
 
LinkBasedRelativeDualityGapFunction - Class in org.planit.gap
Gap function based on the work of Bovy and Jansen (1983) who take the different between the current system travel time and the system travel time if all flow were to be assigned to the shortest paths, divided by the system travel time
LinkBasedRelativeDualityGapFunction(StopCriterion) - Constructor for class org.planit.gap.LinkBasedRelativeDualityGapFunction
Constructor
LinkCostOutputProperty - Class in org.planit.output.property
 
LinkCostOutputProperty() - Constructor for class org.planit.output.property.LinkCostOutputProperty
 
linkId - Variable in class org.planit.network.physical.LinkImpl
unique internal identifier
LinkImpl - Class in org.planit.network.physical
Link class connecting two nodes via some geometry.
LinkImpl(IdGroupingToken, Node, Node, double, String) - Constructor for class org.planit.network.physical.LinkImpl
Constructor which injects link length directly
LinkOutputTypeAdapter - Interface in org.planit.output.adapter
Interface defining the methods required for a link output adapter
LinkOutputTypeAdapterImpl - Class in org.planit.output.adapter
Top-level abstract class which defines the common methods required by Link output type adapters
LinkOutputTypeAdapterImpl(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.LinkOutputTypeAdapterImpl
Constructor
LinkOutputTypeConfiguration - Class in org.planit.output.configuration
The configuration for the link output type.
LinkOutputTypeConfiguration(TrafficAssignment) - Constructor for class org.planit.output.configuration.LinkOutputTypeConfiguration
Constructor Define the default output properties here.
links - Variable in class org.planit.network.physical.PhysicalNetwork
internal class instance containing all link specific functionality
Links() - Constructor for class org.planit.network.physical.PhysicalNetwork.Links
Constructor
linkSegment - Variable in class org.planit.ltm.LinkSegmentBoundary
the link segment of this boundary
LinkSegment - Interface in org.planit.utils.network.physical
 
LinkSegmentBoundary - Class in org.planit.ltm
LinkSegment boundary of a link segment.
LinkSegmentBoundary.Location - Enum in org.planit.ltm
Location types for a link segment boundary
LinkSegmentExpectedResultsDto - Class in org.planit.utils.test
DTO object containing extra fields specific to BPR function The first
LinkSegmentExpectedResultsDto(long, long, double, double, double, double, double) - Constructor for class org.planit.utils.test.LinkSegmentExpectedResultsDto
Constructor
LinkSegmentExternalIdOutputProperty - Class in org.planit.output.property
 
LinkSegmentExternalIdOutputProperty() - Constructor for class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
linkSegmentId - Variable in class org.planit.network.physical.LinkSegmentImpl
unique internal identifier
LinkSegmentIdOutputProperty - Class in org.planit.output.property
 
LinkSegmentIdOutputProperty() - Constructor for class org.planit.output.property.LinkSegmentIdOutputProperty
 
LinkSegmentImpl - Class in org.planit.network.physical
Link segment object representing physical links in the network and storing their properties
LinkSegmentImpl(IdGroupingToken, Link, boolean) - Constructor for class org.planit.network.physical.LinkSegmentImpl
Constructor
linkSegments - Variable in class org.planit.network.physical.PhysicalNetwork
internal class instance containing all link segment specific functionality
LinkSegments() - Constructor for class org.planit.network.physical.PhysicalNetwork.LinkSegments
Constructor
linkSegmentType - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
the link type of this link containing all macroscopic features by user class
LinkTypeOutputProperty - Class in org.planit.output.property
 
LinkTypeOutputProperty() - Constructor for class org.planit.output.property.LinkTypeOutputProperty
 
linkVolumeAccessee - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Link volume accessee object for this cost function
LinkVolumeAccessee - Interface in org.planit.interactor
Link Volume accessee object.
LinkVolumeAccessor - Interface in org.planit.interactor
Link Volume Accessor interface
lockOutputProperties(OutputType) - Method in class org.planit.output.formatter.BaseOutputFormatter
Lock the output keys and values for a specified output type
LOGGER - Static variable in interface org.planit.io.xml.converter.EnumConverter
the logger
LOGGER - Static variable in interface org.planit.io.xml.util.XmlUtils
the logger
LOGGER - Static variable in class org.planit.output.configuration.OutputTypeConfiguration
the logger
Logging - Class in org.planit.logging
Utility class to close the current logger
Logging() - Constructor for class org.planit.logging.Logging
 
LoggingUtils - Class in org.planit.utils.misc
some utilities for consistent logging message creation in PLANit
LoggingUtils() - Constructor for class org.planit.utils.misc.LoggingUtils
 
logitChoiceModel - Variable in class org.planit.route.choice.StochasticRouteChoice
The registered logit choice model
LogitChoiceModel - Class in org.planit.route.choice.logit
The logit choice model base class.
LogitChoiceModel(IdGroupingToken) - Constructor for class org.planit.route.choice.logit.LogitChoiceModel
Constructor
logitChoiceModelFactory - Variable in class org.planit.route.choice.StochasticRouteChoice
logit choice model factory to create logit models to direct the probabilities of choosing paths
LONG - org.planit.output.enums.Type
 
LTM_RELEASE_FLOW_EVENT - Static variable in class org.planit.ltm.event.ReleaseFlowEvent
event type to identify ltm events representing a change in flow that is being released
LTM_TRIGGER_FLOW_EVENT - Static variable in class org.planit.ltm.event.TriggerFlowEvent
event type to identify ltm events representing a change in flow that is exogenously triggered

M

MacroscopicLinkSegment - Interface in org.planit.utils.network.physical.macroscopic
Macroscopic traffic modeling oriented link segment
MacroscopicLinkSegmentImpl - Class in org.planit.network.physical.macroscopic
Link segment for macroscopic transport networks.
MacroscopicLinkSegmentImpl(IdGroupingToken, Link, boolean) - Constructor for class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
Constructor
MacroscopicLinkSegmentType - Interface in org.planit.utils.network.physical.macroscopic
The macroscopic link segment type characteristics are contained in this class
macroscopicLinkSegmentTypeByIdMap - Variable in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Map which stores link segment types by generated Id
MacroscopicLinkSegmentTypeImpl - Class in org.planit.network.physical.macroscopic
Each macroscopic link segment is of a particular type reflecting segment specific properties.
MacroscopicLinkSegmentTypeImpl(IdGroupingToken, String, double, double, Object) - Constructor for class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Constructor
MacroscopicLinkSegmentTypeImpl(IdGroupingToken, String, double, double, Object, Map<Mode, MacroscopicModeProperties>) - Constructor for class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
MacroscopicLinkSegmentTypeXmlHelper - Class in org.planit.io.xml.network.physical.macroscopic
Helper class used to create MacroscopicLinkSegmentType objects for XML input
MacroscopicLinkSegmentTypeXmlHelper(String, double, double, Object) - Constructor for class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
Constructor
MacroscopicModeProperties - Interface in org.planit.utils.network.physical.macroscopic
Contains the properties of a mode specific to a link segment type
MacroscopicModePropertiesImpl - Class in org.planit.network.physical.macroscopic
Mode specific properties for the macroscopic perspective on the supply side, i.e.
MacroscopicModePropertiesImpl() - Constructor for class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
Constructor adopting default values
MacroscopicModePropertiesImpl(double, double) - Constructor for class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
Constructor
MacroscopicNetwork - Class in org.planit.network.physical.macroscopic
Macroscopic Network which stores link segment types
MacroscopicNetwork(IdGroupingToken) - Constructor for class org.planit.network.physical.macroscopic.MacroscopicNetwork
Constructor
MACROSCOPICNETWORK - Static variable in class org.planit.network.physical.PhysicalNetwork
 
MacroscopicNetworkBuilder - Class in org.planit.network.physical.macroscopic
Create network entities for a macroscopic simulation model
MacroscopicNetworkBuilder() - Constructor for class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
 
main(String[]) - Static method in class org.planit.io.PlanItMain
Main method for the PLANitIO program.
ManualInitialLinkSegmentCost - Class in org.planit.cost.physical.initial
Initial Link Segment Cost for which all the link segments have the same cost value for a specified mode
ManualInitialLinkSegmentCost(IdGroupingToken) - Constructor for class org.planit.cost.physical.initial.ManualInitialLinkSegmentCost
Constructor
matrixContents - Variable in class org.planit.od.odmatrix.ODMatrix
matrix of data values
MAXIMUM_DENSITY - org.planit.output.property.OutputProperty
 
MAXIMUM_DENSITY - Static variable in interface org.planit.utils.network.physical.LinkSegment
Default maximum link density
MAXIMUM_SPEED - org.planit.output.property.OutputProperty
 
MaximumDensityOutputProperty - Class in org.planit.output.property
 
MaximumDensityOutputProperty() - Constructor for class org.planit.output.property.MaximumDensityOutputProperty
 
maximumDensityPerLane - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Maximum density in veh/km/lane
maximumSpeedMap - Variable in class org.planit.network.physical.LinkSegmentImpl
Map of maximum speeds along this link for each mode
MaximumSpeedOutputProperty - Class in org.planit.output.property
 
MaximumSpeedOutputProperty() - Constructor for class org.planit.output.property.MaximumSpeedOutputProperty
 
maxSpeed - Variable in class org.planit.network.physical.macroscopic.MacroscopicModePropertiesImpl
Maximum speed of mode (tied to a road segment)
MEMORY_OUTPUT_FORMATTER - Static variable in interface org.planit.output.formatter.OutputFormatter
 
MemoryOutputFormatter - Class in org.planit.output.formatter
OutputFormatter which stores data in memory, using specified keys and output properties.
MemoryOutputFormatter(IdGroupingToken) - Constructor for class org.planit.output.formatter.MemoryOutputFormatter
Constructor
MemoryOutputIterator - Class in org.planit.output.formatter
Iterator which loops through the keys and values stored in the MemoryOutputFormatter This class is a wrapper for MultiKeyPlanItDataIterator.
MemoryOutputIterator(MultiKeyPlanItData) - Constructor for class org.planit.output.formatter.MemoryOutputIterator
Constructor
minimumSystemTravelTime - Variable in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Represents the total travel time if all flow were to be diverted to the shortest paths for all origin-destination pairs
MINUTES - org.planit.output.enums.OutputTimeUnit
 
Mode - Interface in org.planit.utils.network.physical
Interface to represent a mode
MODE_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
MODE_ID - org.planit.output.property.OutputProperty
 
ModeData - Class in org.planit.data
Object to store the flows for each mode during the assignment iterations
ModeData(double[]) - Constructor for class org.planit.data.ModeData
Constructor
ModeExternalIdOutputProperty - Class in org.planit.output.property
 
ModeExternalIdOutputProperty() - Constructor for class org.planit.output.property.ModeExternalIdOutputProperty
 
ModeIdOutputProperty - Class in org.planit.output.property
 
ModeIdOutputProperty() - Constructor for class org.planit.output.property.ModeIdOutputProperty
 
ModeImpl - Class in org.planit.network.physical
A Mode is a user class feature representing a single form of transport (car, truck etc.).
ModeImpl(IdGroupingToken, Object, String, double) - Constructor for class org.planit.network.physical.ModeImpl
Constructor
ModeImpl(IdGroupingToken, String, double) - Constructor for class org.planit.network.physical.ModeImpl
Constructor
modeProperties - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Map of mode properties for each mode for this link segment
modes - Variable in class org.planit.network.physical.PhysicalNetwork
internal class instance containing all modes specific functionality
Modes() - Constructor for class org.planit.network.physical.PhysicalNetwork.Modes
 
MSA - Static variable in class org.planit.sdinteraction.smoothing.Smoothing
short hand for configuring smoothing with MSA instance
MSASmoothing - Class in org.planit.sdinteraction.smoothing
MSA smoothing object
MSASmoothing(IdGroupingToken) - Constructor for class org.planit.sdinteraction.smoothing.MSASmoothing
Constructor
MultiKeyPlanItData - Class in org.planit.data
Class which holds arrays of output property values, identified by arrays of output keys This class is a wrapper for the MultiKeyMap object which is a Map with multiple keys.
MultiKeyPlanItData(OutputProperty[], OutputProperty...) - Constructor for class org.planit.data.MultiKeyPlanItData
Constructor
MultiKeyPlanItData(OutputProperty, OutputProperty...) - Constructor for class org.planit.data.MultiKeyPlanItData
Constructor
MultiKeyPlanItData(OutputProperty, OutputProperty, OutputProperty...) - Constructor for class org.planit.data.MultiKeyPlanItData
Constructor
MultiKeyPlanItData(OutputProperty, OutputProperty, OutputProperty, OutputProperty...) - Constructor for class org.planit.data.MultiKeyPlanItData
Constructor
MultiKeyPlanItDataIterator - Interface in org.planit.data
Iterator which returns the keys and values for each row in a MultiKeyPlanItData object.
MultiKeyPlanItDataIteratorImpl - Class in org.planit.data
Implementation of the MultiKeyPlanItDataIterator interface
MultiKeyPlanItDataIteratorImpl(boolean, IterableMap<Object, Object[]>, MultiKeyMap<Object, Object[]>) - Constructor for class org.planit.data.MultiKeyPlanItDataIteratorImpl
Constructor
MultinomialLogit - Class in org.planit.route.choice.logit
MNL choice model implementation
MultinomialLogit(IdGroupingToken) - Constructor for class org.planit.route.choice.logit.MultinomialLogit
Constructor

N

name - Variable in class org.planit.graph.EdgeImpl
Name of the edge
name - Variable in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
name of the link segment type
NAME - Static variable in class org.planit.output.property.CalculatedSpeedOutputProperty
 
NAME - Static variable in class org.planit.output.property.CapacityPerLaneOutputProperty
 
NAME - Static variable in class org.planit.output.property.CostTimesFlowOutputProperty
 
NAME - Static variable in class org.planit.output.property.DensityOutputProperty
 
NAME - Static variable in class org.planit.output.property.DestinationZoneExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.DestinationZoneIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.DownstreamNodeExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.DownstreamNodeIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.DownstreamNodeLocationOutputProperty
 
NAME - Static variable in class org.planit.output.property.FlowOutputProperty
 
NAME - Static variable in class org.planit.output.property.IterationIndexOutputProperty
 
NAME - Static variable in class org.planit.output.property.LengthOutputProperty
 
NAME - Static variable in class org.planit.output.property.LinkCostOutputProperty
 
NAME - Static variable in class org.planit.output.property.LinkSegmentExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.LinkSegmentIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.LinkTypeOutputProperty
 
NAME - Static variable in class org.planit.output.property.MaximumDensityOutputProperty
 
NAME - Static variable in class org.planit.output.property.MaximumSpeedOutputProperty
 
NAME - Static variable in class org.planit.output.property.ModeExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.ModeIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.NumberOfLanesOutputProperty
 
NAME - Static variable in class org.planit.output.property.ODCostOutputProperty
 
NAME - Static variable in class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.OriginZoneIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.PathIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.PathOutputStringProperty
 
NAME - Static variable in class org.planit.output.property.RunIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.TimePeriodIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.UpstreamNodeIdOutputProperty
 
NAME - Static variable in class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
NAME - Static variable in class org.planit.output.property.VCRatioOutputProperty
 
networkBuilder - Variable in class org.planit.network.physical.PhysicalNetwork
Network builder responsible for constructing all network related (derived) instances
NetworkLoading - Class in org.planit.supply.networkloading
Network loading traffic component
NetworkLoading(IdGroupingToken) - Constructor for class org.planit.supply.networkloading.NetworkLoading
Base constructor
NewellFundamentalDiagram - Class in org.planit.supply.fundamentaldiagram
Newell fundamental diagram traffic component
NewellFundamentalDiagram(IdGroupingToken) - Constructor for class org.planit.supply.fundamentaldiagram.NewellFundamentalDiagram
Constructor
next() - Method in interface org.planit.data.MultiKeyPlanItDataIterator
Returns the next array of keys in the iteration
next() - Method in class org.planit.data.MultiKeyPlanItDataIteratorImpl
Advances the iteration and returns the next array of keys in the iteration
next() - Method in class org.planit.od.odmatrix.ODMatrixIterator
Returns the value in the current cells and increments the current position
next() - Method in class org.planit.od.odroute.ODRouteIterator
Returns the path in the next cell and increments the current position
next() - Method in class org.planit.output.formatter.MemoryOutputIterator
Returns the next array of keys in the iteration
nextNetworkSegmentFlows - Variable in class org.planit.data.ModeData
Flows for the next iteration
Node - Interface in org.planit.utils.network.physical
Node is a vertex but not all vertices are nodes.
NODE_EXTERNAL_ID - org.planit.output.enums.RouteIdType
 
NODE_ID - org.planit.output.enums.RouteIdType
 
nodeId - Variable in class org.planit.network.physical.NodeImpl
Unique node identifier
NodeImpl - Class in org.planit.network.physical
Node representation connected to one or more entry and exit links
NodeImpl(IdGroupingToken) - Constructor for class org.planit.network.physical.NodeImpl
Node constructor
nodeModel - Variable in class org.planit.trafficassignment.CapacityConstrainedAssignment
Node model to use
NodeModel - Class in org.planit.algorithms.nodemodel
Node model algorithm base class
NodeModel - Class in org.planit.supply.network.nodemodel
Node model traffic component
NodeModel() - Constructor for class org.planit.algorithms.nodemodel.NodeModel
 
NodeModel(IdGroupingToken) - Constructor for class org.planit.supply.network.nodemodel.NodeModel
Base constructor
nodeModelFactory - Variable in class org.planit.trafficassignment.builder.CapacityConstrainedTrafficAssignmentBuilder
fundamental diagram factory to create fundamental diagrams used to populate the link model
nodes - Variable in class org.planit.network.physical.PhysicalNetwork
internal class instance containing all nodes specific functionality
Nodes() - Constructor for class org.planit.network.physical.PhysicalNetwork.Nodes
Constructor
NONE - org.planit.output.enums.ODSkimSubOutputType
 
NONE - org.planit.output.enums.Units
 
NOT_SPECIFIED - Static variable in interface org.planit.output.formatter.OutputFormatter
Constant to report that an output value has not been set
notify(EventInterface) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
we wait for a link volume accessee to be provided after it is requested.
notify(EventInterface) - Method in class org.planit.io.input.PlanItInputBuilder
Whenever a project component is created this method will be invoked
notify(EventInterface) - Method in class org.planit.trafficassignment.TraditionalStaticAssignment
Deal with requests for link volume accessees since we are one.
NullaryDoubleSupplier - Class in org.planit.utils.function
Lightweight Nullaryfunction implementation to supply doubles in the form of a NullaryFunction<Double> compatible with OjAlgo
NullaryDoubleSupplier(double) - Constructor for class org.planit.utils.function.NullaryDoubleSupplier
Constructor for double supplier compatible with Nullaryfunction<Double> of OjAlgo
NUMBER_OF_LANES - org.planit.output.property.OutputProperty
 
numberOfEdgeSegments - Variable in class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
The number of edge segments considered
numberOfLanes - Variable in class org.planit.network.physical.LinkSegmentImpl
segment's number of lanes
NumberOfLanesOutputProperty - Class in org.planit.output.property
 
NumberOfLanesOutputProperty() - Constructor for class org.planit.output.property.NumberOfLanesOutputProperty
 
numberOfNetworkSegments - Variable in class org.planit.trafficassignment.TrafficAssignment
holds the count of all link segments in the transport network
numberOfNetworkVertices - Variable in class org.planit.trafficassignment.TrafficAssignment
holds the count of all vertices in the transport network
numberOfVertices - Variable in class org.planit.algorithms.shortestpath.DijkstraShortestPathAlgorithm
The number of vertices in the network

O

OD - org.planit.output.enums.OutputType
 
OD_COST - org.planit.output.property.OutputProperty
 
ODCostOutputProperty - Class in org.planit.output.property
 
ODCostOutputProperty() - Constructor for class org.planit.output.property.ODCostOutputProperty
 
ODData<T> - Interface in org.planit.od
Interface defining methods for objects which store data related to origin and destination
ODDataImpl<T> - Class in org.planit.od
Base class containing common methods required by all classes which implement ODData
ODDataImpl(Zoning.Zones) - Constructor for class org.planit.od.ODDataImpl
Constructor
ODDataIterator<T> - Interface in org.planit.od
Defines methods for an iterator which moves through a matrix of origin-destination cells
ODDataIteratorImpl<T> - Class in org.planit.od
Base class containing common methods required by all classes which implement ODDataIterator
ODDataIteratorImpl(Zoning.Zones) - Constructor for class org.planit.od.ODDataIteratorImpl
Constructor
ODDemandMatrix - Class in org.planit.od.odmatrix.demand
This class handles the OD demand matrix.
ODDemandMatrix(Zoning.Zones) - Constructor for class org.planit.od.odmatrix.demand.ODDemandMatrix
Constructor
odDemands - Variable in class org.planit.demands.Demands
Trip demand matrices
ODMatrix - Class in org.planit.od.odmatrix
This class contains common methods for handling origin-demand matrices.
ODMatrix(Zoning.Zones) - Constructor for class org.planit.od.odmatrix.ODMatrix
Constructor for matrix based OD demand matrix
ODMatrixIterator - Class in org.planit.od.odmatrix
Iterator which runs through rows and columns of an OD matrix, making the value, row and column of each cell available
ODMatrixIterator(Array2D<Double>, Zoning.Zones) - Constructor for class org.planit.od.odmatrix.ODMatrixIterator
Constructor
ODOutputTypeAdapter - Interface in org.planit.output.adapter
Interface defining the methods required for an Origin-Destination output adapter
ODOutputTypeAdapterImpl - Class in org.planit.output.adapter
Top-level abstract class which defines the common methods required by OD output type adapters
ODOutputTypeAdapterImpl(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.ODOutputTypeAdapterImpl
Constructor
ODRouteIterator - Class in org.planit.od.odroute
Iterator which runs through rows and columns of a matrix of Path objects, making the Path, row and column of each cell available
ODRouteIterator(Route[][], Zoning.Zones) - Constructor for class org.planit.od.odroute.ODRouteIterator
Constructor
odRouteMatrices - Variable in class org.planit.route.ODRouteSets
map holding all registered od route matrices by their unique id
ODRouteMatrix - Class in org.planit.od.odroute
This class stores the route objects from each origin to each destination.
ODRouteMatrix(IdGroupingToken, Zoning.Zones) - Constructor for class org.planit.od.odroute.ODRouteMatrix
Constructor
odRouteSet - Variable in class org.planit.route.choice.StochasticRouteChoice
The registered od route set instance
odRouteSets - Variable in class org.planit.project.CustomPlanItProject
The registered OD route sets
odRouteSets - Variable in class org.planit.project.PlanItProjectInput
The registered OD route sets
ODRouteSets - Class in org.planit.route
Contains one or more origin-destination based route sets that can be used in assignment.
ODRouteSets(IdGroupingToken) - Constructor for class org.planit.route.ODRouteSets
Constructor
odRouteSetsFactory - Variable in class org.planit.project.PlanItProjectInput
Object factory for od route sets object
odRouteSetsMap - Variable in class org.planit.project.PlanItProjectInput
The od route sets registered on this project
ODSkimMatrix - Class in org.planit.od.odmatrix.skim
This class stores an OD Skim matrix.
ODSkimMatrix(Zoning.Zones, ODSkimSubOutputType) - Constructor for class org.planit.od.odmatrix.skim.ODSkimMatrix
Constructor
ODSkimSubOutputType - Enum in org.planit.output.enums
Enumeration of possible values of OD Skim Output Type
ONE - Static variable in class org.planit.utils.function.NullaryDoubleSupplier
Create supplier that delivers 1 value
openCsvFileAndWriteHeaders(OutputTypeConfiguration, String) - Method in class org.planit.output.formatter.CsvFileOutputFormatter
Open the CSV output file and write the headers to it
org.planit.algorithms.nodemodel - package org.planit.algorithms.nodemodel
Node model algorithms for PlanIt
org.planit.algorithms.shortestpath - package org.planit.algorithms.shortestpath
Shortest Path algorithms for PlanIt
org.planit.configurator - package org.planit.configurator
Contains the definitions of the configurator classes
org.planit.cost - package org.planit.cost
Contains the definitions of cost classes
org.planit.cost.physical - package org.planit.cost.physical
Contains the definition of physical cost classes
org.planit.cost.physical.initial - package org.planit.cost.physical.initial
Initial Physical Cost objects
org.planit.cost.virtual - package org.planit.cost.virtual
Contains the definitions of virtual cost classes
org.planit.data - package org.planit.data
Data used for calculation during iterations of the traffic assignment
org.planit.demands - package org.planit.demands
Classes which manage traveler demands
org.planit.gap - package org.planit.gap
Gap functions and criteria used to test for convergence of the assignment algorithms
org.planit.geo - package org.planit.geo
Common classes to perform actions on OpenGIS spatial data
org.planit.graph - package org.planit.graph
Network component object classes
org.planit.input - package org.planit.input
Top-level input classes and interfaces
org.planit.interactor - package org.planit.interactor
Interfaces which must be implemented by event accessor classes
org.planit.io - package org.planit.io
PLANit input output package
org.planit.io.input - package org.planit.io.input
Classes to read files in PlanIt's XML format
org.planit.io.output.formatter - package org.planit.io.output.formatter
PLANit IO output formatter package
org.planit.io.project - package org.planit.io.project
Simple implementations of CustomPlanItProject
org.planit.io.xml.converter - package org.planit.io.xml.converter
PLANit IO XML conversion helper classes
org.planit.io.xml.demands - package org.planit.io.xml.demands
Classes used to process the Java classes generated from XSD files
org.planit.io.xml.network - package org.planit.io.xml.network
PLANit IO XML parsing for network
org.planit.io.xml.network.physical.macroscopic - package org.planit.io.xml.network.physical.macroscopic
PLANit IO XML parsing for macroscopic network
org.planit.io.xml.util - package org.planit.io.xml.util
Utility methods to help process XML data
org.planit.io.xml.zoning - package org.planit.io.xml.zoning
Classes to update the Zoning object using input values from the XML zoning input file.
org.planit.logging - package org.planit.logging
This package contains classes for managing logging in PlanIt projects.
org.planit.ltm - package org.planit.ltm
PLANit LTM main package
org.planit.ltm.event - package org.planit.ltm.event
PLANit LTM event classes
org.planit.ltm.trafficassignment - package org.planit.ltm.trafficassignment
PLANit LTM traffic assignment classes
org.planit.network.physical - package org.planit.network.physical
Physical network component object classes
org.planit.network.physical.macroscopic - package org.planit.network.physical.macroscopic
Macroscopic physical network component object classes
org.planit.network.transport - package org.planit.network.transport
Integrated network component object classes
org.planit.network.virtual - package org.planit.network.virtual
Virtual network component object classes
org.planit.od - package org.planit.od
Top-level abstract interfaces to handle Origin-Destination Data
org.planit.od.odmatrix - package org.planit.od.odmatrix
This package contains classes for managing OD matrices.
org.planit.od.odmatrix.demand - package org.planit.od.odmatrix.demand
Contains the definitions of the Origin-Destination Demand classes
org.planit.od.odmatrix.skim - package org.planit.od.odmatrix.skim
This package holds the origin-destination Skim Matrix objects.
org.planit.od.odroute - package org.planit.od.odroute
This package holds the origin-destination path objects.
org.planit.output - package org.planit.output
output writer related classes
org.planit.output.adapter - package org.planit.output.adapter
Output Adapter and Output Type Adapter classes and interfaces
org.planit.output.configuration - package org.planit.output.configuration
output configuration related classes
org.planit.output.enums - package org.planit.output.enums
Enumerations containing possible values of output properties
org.planit.output.formatter - package org.planit.output.formatter
output formatter related classes
org.planit.output.property - package org.planit.output.property
Output property objects which represent quantities which can be reported in the output
org.planit.project - package org.planit.project
PLANit project classes
org.planit.route - package org.planit.route
PLANit route classes
org.planit.route.choice - package org.planit.route.choice
PLANit route choice classes
org.planit.route.choice.logit - package org.planit.route.choice.logit
PLANit logit based route choice classes
org.planit.sdinteraction.smoothing - package org.planit.sdinteraction.smoothing
Classes which perform the smoothing used in the algorithm convergence
org.planit.supply.fundamentaldiagram - package org.planit.supply.fundamentaldiagram
Fundamental diagram classes
org.planit.supply.network.nodemodel - package org.planit.supply.network.nodemodel
Node model classes
org.planit.supply.networkloading - package org.planit.supply.networkloading
Network loading classes
org.planit.time - package org.planit.time
Contains the definition of the TimePeriod object
org.planit.trafficassignment - package org.planit.trafficassignment
Traffic assignment classes
org.planit.trafficassignment.builder - package org.planit.trafficassignment.builder
Traffic assignment builder classes
org.planit.userclass - package org.planit.userclass
Contains the definitions of the user classes (UserClass, TravellerType and Mode)
org.planit.utils.args - package org.planit.utils.args
Utils classes for parsing application arguments
org.planit.utils.arrays - package org.planit.utils.arrays
Util classes for array manipulation and/or management
org.planit.utils.cumulatives - package org.planit.utils.cumulatives
Classes for cumulatives (in a traffic context)
org.planit.utils.exceptions - package org.planit.utils.exceptions
General wrappers for exceptions thrown during program execution
org.planit.utils.function - package org.planit.utils.function
Function utility classes
org.planit.utils.functionalinterface - package org.planit.utils.functionalinterface
Utilities for functional interfaces
org.planit.utils.graph - package org.planit.utils.graph
Utilities for setting up graphs
org.planit.utils.id - package org.planit.utils.id
Utilities for managing and generating unique ids within certain (managed) contexts
org.planit.utils.math - package org.planit.utils.math
Math oriented utility classes
org.planit.utils.misc - package org.planit.utils.misc
Miscellaneous utility classes
org.planit.utils.network.physical - package org.planit.utils.network.physical
Physical network oriented utility classes
org.planit.utils.network.physical.macroscopic - package org.planit.utils.network.physical.macroscopic
Macroscopic physical network oriented utility classes
org.planit.utils.network.virtual - package org.planit.utils.network.virtual
Virtual physical network oriented utility classes
org.planit.utils.output - package org.planit.utils.output
Output oriented utility classes
org.planit.utils.reflection - package org.planit.utils.reflection
Reflection oriented utility classes
org.planit.utils.test - package org.planit.utils.test
Testing specific utility classes
ORIGIN_ZONE_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
ORIGIN_ZONE_ID - org.planit.output.property.OutputProperty
 
OriginDestinationOutputTypeConfiguration - Class in org.planit.output.configuration
The configuration for the origin-destination output type.
OriginDestinationOutputTypeConfiguration(TrafficAssignment) - Constructor for class org.planit.output.configuration.OriginDestinationOutputTypeConfiguration
Constructor Define the default output properties here.
originId - Variable in class org.planit.od.ODDataIteratorImpl
Id of the origin zone
OriginZoneExternalIdOutputProperty - Class in org.planit.output.property
 
OriginZoneExternalIdOutputProperty() - Constructor for class org.planit.output.property.OriginZoneExternalIdOutputProperty
 
OriginZoneIdOutputProperty - Class in org.planit.output.property
 
OriginZoneIdOutputProperty() - Constructor for class org.planit.output.property.OriginZoneIdOutputProperty
 
outgoingLinkSegmentReceivingFlows - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
store the receiving flows of each outgoing link segment at capacity, i.e., R_b=C_b
outgoingLinkSegmentReceivingFlows - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelInput
store the available receiving flows of each outgoing link segment
outgoingLinkSegments - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
mapping of outgoing link index to link segment (if any), i.e.e, b=1,...|B^out|-1
OutputAdapter - Class in org.planit.output.adapter
Output Adapter which stores output type adapters for each Output Manager and defines top-level method which apply to all output types
OutputAdapter(TrafficAssignment) - Constructor for class org.planit.output.adapter.OutputAdapter
Constructor
OutputConfiguration - Class in org.planit.output.configuration
Class containing the general output configuration and the type specific configurations for some traffic assignment
OutputConfiguration() - Constructor for class org.planit.output.configuration.OutputConfiguration
Base constructor
OutputFormatter - Interface in org.planit.output.formatter
Interface for persisting output data in a particular format
OutputFormatterFactory - Class in org.planit.output.formatter
Factory to create output writers of any compatible type
OutputFormatterFactory() - Constructor for class org.planit.output.formatter.OutputFormatterFactory
 
outputFormatters - Variable in class org.planit.project.CustomPlanItProject
The output formatter(s) registered on this project
outputKeyProperties - Variable in class org.planit.output.formatter.BaseOutputFormatter
Map of OutputProperty types of keys for each OutputType
outputManager - Variable in class org.planit.trafficassignment.TrafficAssignment
Output manager deals with all the output configurations for the registered traffic assignments
OutputManager - Class in org.planit.output
Base class for output writers containing basic functionality regarding all things output
OutputManager(TrafficAssignment) - Constructor for class org.planit.output.OutputManager
Base constructor of Output writer
outputProperties - Variable in class org.planit.output.configuration.OutputTypeConfiguration
Output properties to be included in the CSV output files
OutputProperty - Enum in org.planit.output.property
Enumeration of possible output properties
OutputPropertyPriority - Enum in org.planit.output.property
Enumeration giving the priority of output properties.
outputTimeUnit - Variable in class org.planit.output.formatter.BaseOutputFormatter
Time unit to be used in outputs
OutputTimeUnit - Enum in org.planit.output.enums
 
outputType - Variable in class org.planit.output.adapter.OutputTypeAdapterImpl
The OutputType this OutputTypeAdapter is used for
outputType - Variable in class org.planit.output.configuration.OutputTypeConfiguration
The output type being used with the current instance - this must be set in each concrete class which extends OutputTypeConfiguration
OutputType - Enum in org.planit.output.enums
Different configurations exist for different types of output which we identify via this enum GENERAL: LINK: link based output SIMULATION: simulation based output such as profile information, objects created etc.
OutputTypeAdapter - Interface in org.planit.output.adapter
Top-level interface for all output type adapters
OutputTypeAdapterImpl - Class in org.planit.output.adapter
Top-level abstract class which defines the common methods required by all output type adapters
OutputTypeAdapterImpl(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.OutputTypeAdapterImpl
Constructor
OutputTypeConfiguration - Class in org.planit.output.configuration
Configuration for a specific output type including the adapter allowing access to the underlying raw data
OutputTypeConfiguration(TrafficAssignment, OutputType) - Constructor for class org.planit.output.configuration.OutputTypeConfiguration
OutputTypeconfiguration constructor
OutputTypeEnum - Interface in org.planit.output.enums
Marker interface to allow us to store outputType and suboutputTypeEnums in the same collection without issue while still being able to distinguish between the two
outputTypeKeysLocked - Variable in class org.planit.output.formatter.BaseOutputFormatter
Map to store which output types are already in use as keys
outputTypes - Variable in class org.planit.output.formatter.BaseOutputFormatter
List of registered OutputTypes
outputTypeValuesLocked - Variable in class org.planit.output.formatter.BaseOutputFormatter
Map to store whether any data values have been stored for a given output type.
OutputUtils - Class in org.planit.utils.output
Utility Functions used during output
OutputUtils() - Constructor for class org.planit.utils.output.OutputUtils
 
outputValueProperties - Variable in class org.planit.output.formatter.BaseOutputFormatter
Map of OutputProperty types for values for each OutputType

P

Pair<A,​B> - Class in org.planit.utils.misc
Custom pair class similar to C++.
Pair(A, B) - Constructor for class org.planit.utils.misc.Pair
Constructor
parametersPerLinkSegmentAndMode - Variable in class org.planit.cost.physical.BPRLinkTravelTimeCost
Map to store default alpha and beta values for a specific link segment
parentAssignment - Variable in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
The assignment all components will be registered on
parentEdge - Variable in class org.planit.graph.EdgeSegmentImpl
segment's parent edge
parentZone - Variable in class org.planit.network.virtual.CentroidImpl
the zone this centroid represents
PATH - org.planit.output.enums.OutputType
 
PATH_ID - org.planit.output.property.OutputProperty
 
PATH_STRING - org.planit.output.property.OutputProperty
 
PATH_TO_XSD_FILE - Static variable in interface org.planit.io.xml.util.XmlUtils
 
PathIdOutputProperty - Class in org.planit.output.property
 
PathIdOutputProperty() - Constructor for class org.planit.output.property.PathIdOutputProperty
 
PathOutputStringProperty - Class in org.planit.output.property
 
PathOutputStringProperty() - Constructor for class org.planit.output.property.PathOutputStringProperty
 
PathOutputTypeConfiguration - Class in org.planit.output.configuration
The configuration for the OD path output type.
PathOutputTypeConfiguration(TrafficAssignment) - Constructor for class org.planit.output.configuration.PathOutputTypeConfiguration
Constructor Define the default output properties here.
persist(TimePeriod, Set<Mode>, OutputConfiguration, OutputTypeConfiguration, OutputAdapter) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write data to output file
persist(TimePeriod, Set<Mode>, OutputConfiguration, OutputTypeConfiguration, OutputAdapter) - Method in interface org.planit.output.formatter.OutputFormatter
Persist the output data based on the passed in configuration and adapter (contained in the configuration)
persistOnlyFinalIteration - Variable in class org.planit.output.configuration.OutputConfiguration
persisting final iteration only or not
persistOutputData(TimePeriod, Set<Mode>, boolean) - Method in class org.planit.output.OutputManager
Persist the output data for all registered output types
persistZeroFlow - Variable in class org.planit.output.configuration.OutputConfiguration
persisting zero flows or not
physicalCost - Variable in class org.planit.trafficassignment.TrafficAssignment
The physical generalized cost approach
PhysicalCost - Class in org.planit.cost.physical
Class for dynamic cost functions, which calculate link segment costs for each iteration
PhysicalCost(IdGroupingToken) - Constructor for class org.planit.cost.physical.PhysicalCost
 
physicalCostFactory - Variable in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Cost factory to create physical costs to register on the generalized cost.
physicalNetwork - Variable in class org.planit.network.transport.TransportNetwork
Holds the physical road network that is being modeled
physicalNetwork - Variable in class org.planit.trafficassignment.TrafficAssignment
Physical network to use
PhysicalNetwork - Class in org.planit.network.physical
Model free Network consisting of nodes and links, each of which can be iterated over.
PhysicalNetwork(IdGroupingToken, PhysicalNetworkBuilder) - Constructor for class org.planit.network.physical.PhysicalNetwork
Network Constructor
PhysicalNetwork.Links - Class in org.planit.network.physical
Internal class for all Link specific code
PhysicalNetwork.LinkSegments - Class in org.planit.network.physical
Internal class for LinkSegment specific code (non-physical link segments are placed in the zoning)
PhysicalNetwork.Modes - Class in org.planit.network.physical
Internal class for all Mode specific code
PhysicalNetwork.Nodes - Class in org.planit.network.physical
Internal class for all Node specific code
PhysicalNetworkBuilder - Interface in org.planit.network.physical
Build network elements based on chosen network view.
physicalNetworkFactory - Variable in class org.planit.project.PlanItProjectInput
Object Factory for physical network object
physicalNetworkMap - Variable in class org.planit.project.PlanItProjectInput
The physical networks registered on this project
physicalNetworks - Variable in class org.planit.project.CustomPlanItProject
The registered physical networks
physicalNetworks - Variable in class org.planit.project.PlanItProjectInput
The registered physical networks
PiecewiseLinearCumulativeCurve - Class in org.planit.utils.cumulatives
Represents a piecewise linear cumulative curve
PiecewiseLinearCumulativeCurve() - Constructor for class org.planit.utils.cumulatives.PiecewiseLinearCumulativeCurve
Constructor
PLANIT_OUTPUT_FORMATTER - Static variable in interface org.planit.output.formatter.OutputFormatter
Default output formatter supported by PLANit from PLANitIO repository
PlanItException - Exception in org.planit.utils.exceptions
General exception for PlanIt which wraps exceptions thrown during execution
PlanItException(Exception) - Constructor for exception org.planit.utils.exceptions.PlanItException
Constructor using Exception - wraps run-time exceptions
PlanItException(String) - Constructor for exception org.planit.utils.exceptions.PlanItException
Constructor using String - catches logic-driven exceptions
PlanItException(String, Throwable) - Constructor for exception org.planit.utils.exceptions.PlanItException
Constructor using Throwable - wraps run-time exceptions with additional message
PlanitGeoUtils - Class in org.planit.geo
General geotools related utils
PlanitGeoUtils() - Constructor for class org.planit.geo.PlanitGeoUtils
Constructor Uses default coordinate reference system
PlanitGeoUtils(CoordinateReferenceSystem) - Constructor for class org.planit.geo.PlanitGeoUtils
Constructor
PlanItInputBuilder - Class in org.planit.io.input
Class which reads inputs from XML input files
PlanItInputBuilder(String) - Constructor for class org.planit.io.input.PlanItInputBuilder
Constructor which generates the input objects from files in a specified directory, using the default extension ".xml"
PlanItInputBuilder(String, String) - Constructor for class org.planit.io.input.PlanItInputBuilder
Constructor which generates the input objects from files in a specified directory
PlanItMain - Class in org.planit.io
Test class to run XML input files.
PlanItMain() - Constructor for class org.planit.io.PlanItMain
 
PlanItOutputFormatter - Class in org.planit.io.output.formatter
The default output formatter of PlanIt
PlanItOutputFormatter(IdGroupingToken) - Constructor for class org.planit.io.output.formatter.PlanItOutputFormatter
Constructor, uses default values for properties file name, description property and version property
PlanItOutputFormatter(IdGroupingToken, String) - Constructor for class org.planit.io.output.formatter.PlanItOutputFormatter
Constructor, uses default values description property and version property
PlanItOutputFormatter(IdGroupingToken, String, String, String) - Constructor for class org.planit.io.output.formatter.PlanItOutputFormatter
Constructor, takes values for properties file name, description and version property
PlanItProject - Class in org.planit.io.project
PLANit project which is nothing more than a CustomPlanItProject without any custom configuration pre-embedded.
PlanItProject(String) - Constructor for class org.planit.io.project.PlanItProject
Constructor taking project path where to find all project input files
PlanItProjectInput - Class in org.planit.project
Class that holds all the input traffic components for a PLANit project.
PlanItProjectInput(long, IdGroupingToken, InputBuilderListener) - Constructor for class org.planit.project.PlanItProjectInput
Constructor
PlanItProjectInput.ProjectDemands - Class in org.planit.project
Internal class for registered demands
PlanItProjectInput.ProjectNetworks - Class in org.planit.project
Internal class for registered physical networks
PlanItProjectInput.ProjectODRouteSets - Class in org.planit.project
Internal class for registered od route sets
PlanItProjectInput.ProjectZonings - Class in org.planit.project
Internal class for registered zonings
PlanItSimpleProject - Class in org.planit.io.project
Wrapper around PLANitProject with most common defaults automatically activated.
PlanItSimpleProject() - Constructor for class org.planit.io.project.PlanItSimpleProject
Base constructor for simple project which adopts the PlanItIO input/output format.
PlanItSimpleProject(String) - Constructor for class org.planit.io.project.PlanItSimpleProject
Base constructor for simple project which adopts the PlanItIO input/output format
PlanItSimpleProject(PlanItInputBuilder) - Constructor for class org.planit.io.project.PlanItSimpleProject
Default constructor without explicit project path (use default)
populateDemands(Demands, Object, Object) - Method in class org.planit.io.input.PlanItInputBuilder
Populates the Demands object from the input file
populateInitialLinkSegmentCost(InitialLinkSegmentCost, Object, Object) - Method in class org.planit.io.input.PlanItInputBuilder
Populate the initial link segment cost from a CSV file
populatePhysicalNetwork(PhysicalNetwork) - Method in class org.planit.io.input.PlanItInputBuilder
Creates the physical network object from the data in the input file
populateZoning(Zoning, Object) - Method in class org.planit.io.input.PlanItInputBuilder
Creates the Zoning object and connectoids from the data in the input file
Precision - Class in org.planit.utils.math
compare doubles with a certain precision
Precision() - Constructor for class org.planit.utils.math.Precision
 
ProcessConfiguration - Class in org.planit.io.xml.demands
Methods to generate and store PLANit configuration objects from the configuration object in the XML demand input file.
ProcessConfiguration() - Constructor for class org.planit.io.xml.demands.ProcessConfiguration
 
processedInLinkSegments - Variable in class org.planit.algorithms.nodemodel.TampereNodeModel
track which in-link segments are processed X_topbar.
ProcessInfrastructure - Class in org.planit.io.xml.network
Process the Infrastructure object populated with data from the XML file
ProcessInfrastructure() - Constructor for class org.planit.io.xml.network.ProcessInfrastructure
 
ProcessLinkConfiguration - Class in org.planit.io.xml.network
Process the LinkConfiguration object populated with data from the XML file
ProcessLinkConfiguration() - Constructor for class org.planit.io.xml.network.ProcessLinkConfiguration
 
ProjectAssignments() - Constructor for class org.planit.project.CustomPlanItProject.ProjectAssignments
 
ProjectDemands() - Constructor for class org.planit.project.PlanItProjectInput.ProjectDemands
 
ProjectNetworks() - Constructor for class org.planit.project.PlanItProjectInput.ProjectNetworks
 
ProjectODRouteSets() - Constructor for class org.planit.project.PlanItProjectInput.ProjectODRouteSets
 
projectToken - Variable in class org.planit.project.CustomPlanItProject
id generation using this token will be contiguous and unique for all instances created with this token.
ProjectZonings() - Constructor for class org.planit.project.PlanItProjectInput.ProjectZonings
 
putRow(Object[], Object...) - Method in class org.planit.data.MultiKeyPlanItData
Puts the data values into a specified row
putRowValue(OutputProperty, Object, Object...) - Method in class org.planit.data.MultiKeyPlanItData
Set the data value for an individual cell

Q

QuadConsumer<T,​U,​V,​W> - Interface in org.planit.utils.functionalinterface
Function Interface which can process four input objects.

R

ReflectionUtils - Class in org.planit.utils.reflection
Reflection specific utility functions
ReflectionUtils() - Constructor for class org.planit.utils.reflection.ReflectionUtils
 
registerCentroid(Centroid) - Method in class org.planit.network.virtual.VirtualNetwork.Centroids
Add centroid to the internal container If centroid overrides an existing centroid, the removed centroid is returned
registerConnectoid(Connectoid) - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Add connectoid to the internal container If new connectoid overrides an existing connectoid, the removed connectoid is returned
registerConnectoidSegment(ConnectoidSegment) - Method in class org.planit.network.virtual.VirtualNetwork.ConnectoidSegments
Register a connectid segment on the zoning
registerConnectoidSegment(ConnectoidSegment, boolean) - Method in class org.planit.network.virtual.ConnectoidImpl
Register connectoidSegment.
registerConnectoidSegment(ConnectoidSegment, boolean) - Method in interface org.planit.utils.network.virtual.Connectoid
Register connectoidSegment.
registerDelayedSetter(String, Object...) - Method in class org.planit.configurator.Configurator
Register a method call to a setter that should be invoked on the to be configured object instance once it is available
registerEdgeSegment(EdgeSegment, boolean) - Method in class org.planit.graph.EdgeImpl
Register EdgeSegment.
registeredTrafficAssignmentComponents - Static variable in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
Register per traffic assignment component type the derived classes that are supported
registerEligibleTrafficComponentClass(Class<? extends TrafficAssignmentComponent<?>>) - Method in class org.planit.project.CustomPlanItProject
Register a class that we allow to be instantiated as a concrete implementation of a traffic assignment component that can be used in PLANit
registerInitialLinkSegmentCost(InitialLinkSegmentCost) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Register the initial link segment cost without relating it to a particular period, meaning that it is applied to all time periods that do not have a specified initial link segment costs registered for them
registerInitialLinkSegmentCost(InitialLinkSegmentCostPeriod) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Register the initial link segment cost for the time period embedded in it
registerInitialLinkSegmentCost(TimePeriod, InitialLinkSegmentCost) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Register the initial link segment cost for a specified time period
registerLink(Link) - Method in class org.planit.network.physical.PhysicalNetwork.Links
Add link to the internal container
registerLinkSegment(Link, LinkSegment, boolean) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Register a link segment
registerLinkSegment(LinkSegment) - Method in class org.planit.network.physical.PhysicalNetwork.LinkSegments
Register a link segment on the network
registerLinkSegment(LinkSegment, boolean) - Method in class org.planit.network.physical.LinkImpl
Register linkSegment.
registerLinkSegment(LinkSegment, boolean) - Method in interface org.planit.utils.network.physical.Link
Register linkSegment.
registerLinkSegmentType(MacroscopicLinkSegmentType) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetwork
Register a link segment type on the network
registerMode(Mode) - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Add mode to the internal container
registerNewCentroid(Zone) - Method in class org.planit.network.virtual.VirtualNetwork.Centroids
Create new centroid
registerNewConnectoid(Zoning, PhysicalNetwork.Nodes, XMLElementZones.Zone, Centroid, InputBuilderListener) - Static method in class org.planit.io.xml.zoning.UpdateZoning
Generates and registers a Connectoid object from the current Centroid and generated Zone object
registerNewConnectoid(Centroid, Node, double) - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Create new connectoid to from a specified centroid to a specified node
registerNewConnectoid(Centroid, Node, double, Object) - Method in class org.planit.network.virtual.VirtualNetwork.Connectoids
Create new connectoid to from a specified centroid to a specified node
registerNewLink(Node, Node, double, String) - Method in class org.planit.network.physical.PhysicalNetwork.Links
Create new link to network identified via its id, injecting link length directly
registerNewMode(long, String, double) - Method in class org.planit.network.physical.PhysicalNetwork.Modes
Create and register new mode
registerNewNode() - Method in class org.planit.network.physical.PhysicalNetwork.Nodes
Create and register new node
registerNode(Node) - Method in class org.planit.network.physical.PhysicalNetwork.Nodes
Add node to the internal container
registerODDemand(TimePeriod, Mode, ODDemandMatrix) - Method in class org.planit.demands.Demands
Register provided odDemand
registerOdRouteMatrix(ODRouteMatrix) - Method in class org.planit.route.ODRouteSets
register the passed in route matrix (not copied)
RegisterODRouteMatrix(ODRouteMatrix) - Method in class org.planit.route.choice.StochasticRouteChoice
Register a fixed od route set to use in the form of an ODPathMatrix
registerOutputFormatter(OutputFormatter) - Method in class org.planit.output.OutputManager
Register the output formatter on the output manager.
registerOutputFormatter(OutputFormatter) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Register an output formatter
registerOutputFormatter(OutputFormatter) - Method in class org.planit.trafficassignment.TrafficAssignment
Register the output formatter on the assignment
registerOutputTypeAdapter(OutputType, OutputTypeAdapter) - Method in class org.planit.output.adapter.OutputAdapter
Store an output type adapters for a specified output type
registerOutputTypeAdapter(OutputType, OutputTypeAdapter) - Method in class org.planit.output.OutputManager
Register the OutputTypeAdapter for a given output type
registerTimePeriod(TimePeriod) - Method in class org.planit.demands.Demands.TimePeriods
Register a time period
registerTrafficAssignmentComponentType(Class<? extends TrafficAssignmentComponent<?>>) - Static method in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
Register a component type that one can choose for the given traffic component
registerTravelerType(TravelerType) - Method in class org.planit.demands.Demands.TravelerTypes
Register a traveler type
registerUserClass(UserClass) - Method in class org.planit.demands.Demands.UserClasses
Register a user class
registerZone(Zone) - Method in class org.planit.network.virtual.Zoning.Zones
Add zone to the internal container.
ReleaseEvent - Class in org.planit.ltm.event
A release event represents the arrival of a trigger event at the opposite link boundary from where it originated.
ReleaseEvent(EventType, TriggerEvent, CumulativePoint, Serializable) - Constructor for class org.planit.ltm.event.ReleaseEvent
Constructor
ReleaseFlowEvent - Class in org.planit.ltm.event
A release flow event represents a flow rate that is being released on a link boundary on the opposite border from where it was triggered through a trigger event.
ReleaseFlowEvent(TriggerFlowEvent, CumulativePoint, double) - Constructor for class org.planit.ltm.event.ReleaseFlowEvent
Constructor
remainingReceivingFlows - Variable in class org.planit.algorithms.nodemodel.TampereNodeModel
store the remaining receiving flows of each outgoing link segment
removeAllProperties() - Method in class org.planit.output.configuration.OutputTypeConfiguration
Remove all properties from the current output list
removeEdge(Edge) - Method in class org.planit.graph.VertexImpl.EdgesImpl
#Remove edge
removeEdge(Edge) - Method in interface org.planit.utils.graph.Vertex.Edges
Remove edge
removeEdgeSegment(EdgeSegment) - Method in class org.planit.graph.VertexImpl.EdgeSegmentsImpl
#Remove edgeSegment
removeEdgeSegment(EdgeSegment) - Method in interface org.planit.utils.graph.Vertex.EdgeSegments
Remove edgeSegment
removeProperty(String) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Remove an output property from the list of properties to be included in the output file
removeProperty(OutputProperty) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Remove an output property from the list of properties to be included in the output file
removeVirtualNetworkFromPhysicalNetwork() - Method in class org.planit.network.transport.TransportNetwork
Remove the edges and edge segments on the vertices of both virtual and physical networks
reset() - Method in class org.planit.gap.GapFunction
Reset the gap function
reset() - Method in class org.planit.gap.LinkBasedRelativeDualityGapFunction
Reset system travel time and convexity bound to zero
reset() - Static method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
Reset the store of existing links
reset() - Static method in class org.planit.utils.id.IdGenerator
Reset the id generation at the start of a run
resetCsvDirectory() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Call this method to delete all existing files in the CSV output directory
resetCurrentNetworkSegmentFlows() - Method in class org.planit.data.ModeData
Reset current network segment flows
resetModalNetworkSegmentFlows(Mode, int) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Reset modal network segment flows by cloning empty array
resetNextNetworkSegmentFlows() - Method in class org.planit.data.ModeData
Reset the segment flows for the coming iteration
resetPathMatrix(Mode, Zoning.Zones) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Reset the path matrix to empty for a specified mode for all activated
resetSkimMatrix(Mode, Zoning.Zones) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Reset the skim matrix to all zeroes for a specified mode for all activated skim output types
resetXmlDirectory() - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Call this method to delete all existing files in the XML output directory
RESULT_PRIORITY - org.planit.output.property.OutputPropertyPriority
 
Route - Interface in org.planit.route
Route interface representing a route through the network on edge segment level
routeChoice - Variable in class org.planit.trafficassignment.DynamicTrafficAssignment
the route choice methodology adopted
RouteChoice - Class in org.planit.route.choice
The route choice traffic assignment component responsible for the configuration of the route choice methodology and the routes associated with this procedure.
RouteChoice(IdGroupingToken) - Constructor for class org.planit.route.choice.RouteChoice
Constructor
RouteChoiceBuilder - Interface in org.planit.route.choice
The type of Route choice is sometimes but not always a choice for any given traffic assignment model.
routeChoiceFactory - Variable in class org.planit.trafficassignment.builder.DynamicTrafficAssignmentBuilder
the route choice factory
RouteIdType - Enum in org.planit.output.enums
Enumeration of possible Id types used to identify a Route
RouteImpl - Class in org.planit.route
This object creates a route of LinkSegment objects to a specified destination using the vertexPathAndCost object created by the (Dijkstra) Shortest Path Algorithm The path creation makes use of the fact that the origin pair will have a null EdgeSegment, so there is no need to specify the origin.
RouteImpl(IdGroupingToken) - Constructor for class org.planit.route.RouteImpl
Constructor
RouteImpl(IdGroupingToken, List<EdgeSegment>) - Constructor for class org.planit.route.RouteImpl
Constructor
RouteOutputTypeAdapter - Interface in org.planit.output.adapter
 
RouteOutputTypeAdapterImpl - Class in org.planit.output.adapter
Top-level abstract class which defines the common methods required by Path output type adapters
RouteOutputTypeAdapterImpl(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.RouteOutputTypeAdapterImpl
Constructor
run() - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Run the Tampere node model
RUN_ID - org.planit.output.property.OutputProperty
 
RunIdOutputProperty - Class in org.planit.output.property
 
RunIdOutputProperty() - Constructor for class org.planit.output.property.RunIdOutputProperty
 

S

scaledRemainingTurnSendingFlows - Variable in class org.planit.algorithms.nodemodel.TampereNodeModel
store the remaining turn sending flows
second - Variable in class org.planit.utils.misc.Pair
The second object in this Pair
SECONDS - org.planit.output.enums.OutputTimeUnit
 
setAllSegmentCosts(Mode, double, int) - Method in class org.planit.cost.physical.initial.ManualInitialLinkSegmentCost
Sets a given cost for all link segments for a given mode
setCapacity(double) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Sets the capacity of this link
setCapacityPerLane(double) - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
setCentrePointGeometry(DirectPosition) - Method in class org.planit.graph.VertexImpl
#Set the center point geometry for a vertex
setCentrePointGeometry(DirectPosition) - Method in interface org.planit.utils.graph.Vertex
Set the center point geometry for a vertex
setCentroid(Centroid) - Method in class org.planit.network.virtual.ZoneImpl
Set the centroid of this zone
setConnectiodSpeed(double) - Method in class org.planit.cost.virtual.SpeedConnectoidTravelTimeCost
set the connectoid speed
setCsvDirectory(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Set the directory for CSV output files
setCsvDirectory(String) - Method in interface org.planit.output.formatter.CsvTextFileOutputFormatter
Sets the directory of the CSV output files for all output types
setCsvNameExtension(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Sets the extension of the CSV output file
setCsvNameExtension(String) - Method in interface org.planit.output.formatter.CsvTextFileOutputFormatter
Sets the extension of the CSV output file name for all output types
setCsvNameRoot(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Sets the root name of the CSV output file
setCsvNameRoot(String) - Method in interface org.planit.output.formatter.CsvTextFileOutputFormatter
Set the root name of the CSV output file for all output types
setDefaultParameters(double, double) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Set the default alpha and beta values
setDefaultParameters(MacroscopicLinkSegmentType, Mode, double, double) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Set the default alpha and beta values for a given link type and mode
setDefaultParameters(Mode, double, double) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Set the default alpha and beta values for a mode
setDemands(Demands) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the Demands object for the current assignment
setDescription(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Allows the developer to set the output description property
setEndNodeId(long) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the id of the end node
setEpsilon(double) - Method in class org.planit.gap.StopCriterion
Set the epsilon of this stopping criterion
setErrorIfDuplicateExternalId(boolean) - Method in class org.planit.input.InputBuilderListener
Set whether input files having duplicate external Ids should be treated as an error
setEventContentByIndex(int, Serializable) - Method in class org.planit.ltm.event.CumulativeEvent
set content entry on the event explicitly
setExternalId(Object) - Method in class org.planit.graph.EdgeSegmentImpl
set external id of the instance.
setExternalId(Object) - Method in class org.planit.network.physical.LinkImpl
 
setExternalId(Object) - Method in class org.planit.network.physical.NodeImpl
Set the external id of the node
setExternalId(Object) - Method in class org.planit.network.virtual.ConnectoidImpl
 
setExternalId(Object) - Method in interface org.planit.utils.graph.EdgeSegment
set external id of the instance.
setExternalId(Object) - Method in interface org.planit.utils.network.physical.Link
Set the external id
setExternalId(Object) - Method in interface org.planit.utils.network.physical.Node
Set the external id of the node
setExternalId(Object) - Method in interface org.planit.utils.network.virtual.Connectoid
set the external id of this connectoid
setFixedConnectoidCost(double) - Method in class org.planit.cost.virtual.FixedConnectoidTravelTimeCost
 
setFundamentalDiagram(FundamentalDiagram) - Method in class org.planit.trafficassignment.CapacityConstrainedAssignment
Set the fundamental diagram
setGapFunction(GapFunction) - Method in class org.planit.trafficassignment.TrafficAssignment
Collect the gap function which is to be set by a derived class of TrafficAssignment via the initialiseDefaults() right after construction
setIdGroupingToken(IdGroupingToken) - Method in class org.planit.network.physical.macroscopic.MacroscopicNetworkBuilder
Each builder needs a group if token to allow all underlying factory methods to generated ids uniquely tied to the group the entities belong to
setIdGroupingToken(IdGroupingToken) - Method in interface org.planit.network.physical.PhysicalNetworkBuilder
Each builder needs a group if token to allow all underlying factory methods to generated ids uniquely tied to the group the entities belong to
setInitialLinkSegmentCost(InitialLinkSegmentCost) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the initial link segment cost unrelated to any particular time period, i.e., used for all time periods that do not have designated initial costs specified for them
setInitialLinkSegmentCost(TimePeriod, InitialLinkSegmentCost) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the initial link segment cost for a specified time period, otherwise revert to the general initial link segment cost (if any)
setInLinkSegmentProcessed(int) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Mark in-link segment as processed
setIterationIndex(int) - Method in class org.planit.data.SimulationData
Set the current iteration index
setLength(double) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the length of this link
setLinkCost(double) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the cost for the current link
setLinkFlow(double) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the flow through this link
setLinkSegmentType(MacroscopicLinkSegmentType) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentImpl
 
setLinkSegmentType(MacroscopicLinkSegmentType) - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegment
Set the link segment type this link segment adheres to
setMaximumDensityPerLane(double) - Method in class org.planit.io.xml.network.physical.macroscopic.MacroscopicLinkSegmentTypeXmlHelper
 
setMaximumSpeed(Mode, double) - Method in class org.planit.network.physical.LinkSegmentImpl
Set the maximum speed along this link for a specified mode
setMaximumSpeed(Mode, double) - Method in interface org.planit.utils.network.physical.LinkSegment
Set the maximum speed along this link for a specified mode
setMaxIterations(int) - Method in class org.planit.gap.StopCriterion
Set the maximum allowable number of iterations
setModalLinkSegmentCosts(Mode, double[]) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Set the link segment costs for a specified mode
setModalNetworkSegmentFlows(Mode, double[]) - Method in class org.planit.data.TraditionalStaticAssignmentSimulationData
Set the flows for a specified mode
setModeProperties(Map<Mode, MacroscopicModeProperties>) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
Set the map of mode properties for this link
setModeProperties(Map<Mode, MacroscopicModeProperties>) - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Set the map of mode properties for this link
setName(String) - Method in class org.planit.graph.EdgeImpl
set the name of this edge
setName(String) - Method in class org.planit.network.physical.macroscopic.MacroscopicLinkSegmentTypeImpl
 
setName(String) - Method in interface org.planit.utils.network.physical.macroscopic.MacroscopicLinkSegmentType
Set the name of this macroscopic link segment type
setNodeModel(NodeModel) - Method in class org.planit.trafficassignment.CapacityConstrainedAssignment
The node model to use
setNumberOfLanes(int) - Method in class org.planit.network.physical.LinkSegmentImpl
 
setNumberOfLanes(int) - Method in interface org.planit.utils.network.physical.LinkSegment
Set the number of lanes
setOutputDirectory(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Set the common directory
setOutputTimeUnit(OutputTimeUnit) - Method in class org.planit.output.formatter.BaseOutputFormatter
Sets the current time units
setParameters(MacroscopicLinkSegment, Mode, double, double) - Method in class org.planit.cost.physical.BPRLinkTravelTimeCost
Set the alpha and beta values for a given link segment and mode
setPathIdType(RouteIdType) - Method in class org.planit.output.configuration.PathOutputTypeConfiguration
Set the path id type
setPersistOnlyFinalIteration(boolean) - Method in class org.planit.output.configuration.OutputConfiguration
Set whether only the final iteration will be recorded (default is true)
setPersistZeroFlow(boolean) - Method in class org.planit.output.configuration.OutputConfiguration
Set whether links and paths with zero flow should be record (default is false)
setPhysicalCost(PhysicalCost) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the physical cost where in case the cost is an InteractorAccessor will trigger an event to get access to the required data via requesting an InteractorAccessee
setPhysicalNetwork(PhysicalNetwork) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the PhysicalNetwork for the current assignment
setRouteChoice(RouteChoice) - Method in class org.planit.trafficassignment.DynamicTrafficAssignment
set the route choice methodology as to be adopted by this traffic assignment
setSegmentCost(Mode, long, double) - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Sets the initial cost for each link segment and mode
setSegmentCost(Mode, LinkSegment, double) - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCost
Sets the initial cost for each link segment and mode
setSegmentCost(Mode, LinkSegment, double) - Method in class org.planit.cost.physical.initial.InitialPhysicalCost
Set the initial cost for a specified mode and link segment
setSmoothing(Smoothing) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the Smoothing object for the current assignment
setSpeed(double) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the travel speed for this link
setStartNodeId(long) - Method in class org.planit.utils.test.LinkSegmentExpectedResultsDto
Set the id of the end node
setTimePeriod(TimePeriod) - Method in class org.planit.cost.physical.initial.InitialLinkSegmentCostPeriod
 
setValue(Zone, Zone, Double) - Method in class org.planit.od.odmatrix.ODMatrix
Sets the value for a specified origin and destination
setValue(Zone, Zone, Route) - Method in class org.planit.od.odroute.ODRouteMatrix
Set the path from a specified origin to a specified destination
setValue(Zone, Zone, T) - Method in interface org.planit.od.ODData
Sets the value for a specified origin and destination
setVirtualCost(VirtualCost) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the virtual cost where in case the cost is an InteractorAccessor will trigger an event to get access to the required data via requesting an InteractorAccessee
setXmlDirectory(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Set the output directory for XML output files
setXmlDirectory(String) - Method in interface org.planit.output.formatter.XmlTextFileOutputFormatter
Sets the directory of the XML output files for all output types
setXmlFileNamePerOutputType(OutputType, String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Set the name of an XML output file for a specified output type
setXmlFileNamePerOutputType(OutputType, String) - Method in interface org.planit.output.formatter.XmlTextFileOutputFormatter
Set the name of an XML output file for a specified output type
setXmlNameExtension(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Sets the extension of the XML output file
setXmlNameExtension(String) - Method in interface org.planit.output.formatter.XmlTextFileOutputFormatter
Sets the extension of the XML output file name for all output types
setXmlNameRoot(String) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Sets the root name of the XML output file
setXmlNameRoot(String) - Method in interface org.planit.output.formatter.XmlTextFileOutputFormatter
Set the root name of the XML output file for all output types
setZoning(Zoning) - Method in class org.planit.trafficassignment.TrafficAssignment
Set the zoning object for the current assignment
ShortestPathAlgorithm - Interface in org.planit.algorithms.shortestpath
An algorithm which calculates the shortest (a.k.a.
SIMULATION - org.planit.output.enums.OutputType
 
SimulationData - Class in org.planit.data
General simulation data that only are available during simulation
SimulationData() - Constructor for class org.planit.data.SimulationData
 
smoothing - Variable in class org.planit.trafficassignment.TrafficAssignment
the smoothing to use
Smoothing - Class in org.planit.sdinteraction.smoothing
Smoothing class to smooth data, such as path flows or other types of flows or traffic data between iterations
Smoothing(IdGroupingToken) - Constructor for class org.planit.sdinteraction.smoothing.Smoothing
Base constructor
smoothingFactory - Variable in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
The smoothing factory used in the assignment algorithm NB: The smoothing factory is defined here because the same smoothing algorithm is used for all assignments.
SPEED - Static variable in class org.planit.cost.virtual.VirtualCost
short hand for configuring speed based virtual cost instance
SpeedConnectoidTravelTimeCost - Class in org.planit.cost.virtual
Class to calculate the connectoid travel time using connectoid speed
SpeedConnectoidTravelTimeCost(IdGroupingToken) - Constructor for class org.planit.cost.virtual.SpeedConnectoidTravelTimeCost
Constructor
SRS - org.planit.output.enums.Units
 
SRSNAME - org.planit.output.enums.Type
 
StackWalkerUtil - Class in org.planit.utils.reflection
Utils class warpping the Stackwalker API functionality in easy to use method calls.
StackWalkerUtil() - Constructor for class org.planit.utils.reflection.StackWalkerUtil
 
stepSize - Variable in class org.planit.sdinteraction.smoothing.MSASmoothing
Step size
StochasticRouteChoice - Class in org.planit.route.choice
Stochastic route choice component.
StochasticRouteChoice(IdGroupingToken, InputBuilderListener) - Constructor for class org.planit.route.choice.StochasticRouteChoice
Constructor
stopCriterion - Variable in class org.planit.gap.GapFunction
The stopCriterion to use
StopCriterion - Class in org.planit.gap
StopCriterion class.
StopCriterion() - Constructor for class org.planit.gap.StopCriterion
 
STRING - org.planit.output.enums.Type
 
SubOutputTypeEnum - Interface in org.planit.output.enums
Marker interface to indicate enums that are of a subtype of OutputType
surroundwithBrackets(String) - Static method in class org.planit.utils.misc.LoggingUtils
Surround string with brackets "[%s]"

T

TampereNodeModel - Class in org.planit.algorithms.nodemodel
General First order node model implementation as proposed by Tampere et al.
TampereNodeModel - Class in org.planit.supply.network.nodemodel
Tampere node model traffic component
TampereNodeModel(TampereNodeModelInput) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModel
Constructor
TampereNodeModel(IdGroupingToken) - Constructor for class org.planit.supply.network.nodemodel.TampereNodeModel
Base Constructor
TampereNodeModelFixedInput - Class in org.planit.algorithms.nodemodel
Inner class that holds the mapping of the inputs to/from the underlying physical network (if any).
TampereNodeModelFixedInput(Array1D<Double>) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
Constructor.
TampereNodeModelFixedInput(Array1D<Double>, Array1D<Double>) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
Constructor.
TampereNodeModelFixedInput(Node, boolean) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModelFixedInput
Constructor.
TampereNodeModelInput - Class in org.planit.algorithms.nodemodel
Inner class that allows the user to set all inputs for the TampereNodeModel, it takes fixed inputs and supplements it with the information of the variable inputs, meaning inputs that can vary during the simulation such as turn sending flows (t_ab), and potentially receiving flows (r_b)
TampereNodeModelInput(TampereNodeModelFixedInput, Array2D<Double>) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModelInput
Constructor for a particular node model run
TampereNodeModelInput(TampereNodeModelFixedInput, Array2D<Double>, Array1D<Double>) - Constructor for class org.planit.algorithms.nodemodel.TampereNodeModelInput
Constructor for a particular node model run.
TestOutputDto<A,​B,​C> - Class in org.planit.utils.test
Data Transfer Object used to store results in unit testing for PlanItIO
TestOutputDto(A, B, C) - Constructor for class org.planit.utils.test.TestOutputDto
 
throwIf(boolean, String) - Static method in exception org.planit.utils.exceptions.PlanItException
Throw a planitException if condition is met
TIME_PERIOD_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
TIME_PERIOD_ID - org.planit.output.property.OutputProperty
 
timePeriod - Variable in class org.planit.cost.physical.initial.InitialLinkSegmentCostPeriod
The time period which this initial cost object applies to.
TimePeriod - Class in org.planit.time
Represents a time period within the day.
TimePeriod(IdGroupingToken, Object, long, long) - Constructor for class org.planit.time.TimePeriod
Constructor
TimePeriod(IdGroupingToken, Object, String, long, long) - Constructor for class org.planit.time.TimePeriod
Constructor
TimePeriodExternalIdOutputProperty - Class in org.planit.output.property
 
TimePeriodExternalIdOutputProperty() - Constructor for class org.planit.output.property.TimePeriodExternalIdOutputProperty
 
TimePeriodIdOutputProperty - Class in org.planit.output.property
 
TimePeriodIdOutputProperty() - Constructor for class org.planit.output.property.TimePeriodIdOutputProperty
 
timePeriods - Variable in class org.planit.demands.Demands
internal class instance containing all time periods on this demand instance
TimePeriods() - Constructor for class org.planit.demands.Demands.TimePeriods
Constructor
toList() - Method in class org.planit.project.PlanItProjectInput.ProjectDemands
Returns a List of demands
toList() - Method in class org.planit.project.PlanItProjectInput.ProjectNetworks
Returns a List of networks
toList() - Method in class org.planit.project.PlanItProjectInput.ProjectODRouteSets
Returns a List of od route sets
toList() - Method in class org.planit.project.PlanItProjectInput.ProjectZonings
Returns a List of zoning
toString() - Method in class org.planit.time.TimePeriod
Output this object as a String
toString() - Method in class org.planit.utils.id.IdGroupingToken
collect the string token
toString() - Method in class org.planit.utils.misc.Pair
Convert to string
toString(RouteIdType) - Method in interface org.planit.route.Route
Outputs this path as a String, appropriate to a specified path output type
toString(RouteIdType) - Method in class org.planit.route.RouteImpl
Outputs this path as a String, appropriate to a specified path output type
TRADITIONAL_STATIC_ASSIGNMENT - Static variable in class org.planit.trafficassignment.TrafficAssignment
 
TraditionalStaticAssignment - Class in org.planit.trafficassignment
Traditional static assignment traffic component.
TraditionalStaticAssignment(IdGroupingToken) - Constructor for class org.planit.trafficassignment.TraditionalStaticAssignment
Base Constructor
TraditionalStaticAssignmentBuilder - Class in org.planit.trafficassignment.builder
Builder for a traditional static assignment.
TraditionalStaticAssignmentBuilder(TrafficAssignment, InputBuilderListener, Demands, Zoning, PhysicalNetwork) - Constructor for class org.planit.trafficassignment.builder.TraditionalStaticAssignmentBuilder
Constructor
TraditionalStaticAssignmentLinkOutputTypeAdapter - Class in org.planit.output.adapter
Adapter providing access to the data of the TraditionalStaticAssignment class relevant for link outputs without exposing the internals of the traffic assignment class itself
TraditionalStaticAssignmentLinkOutputTypeAdapter(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.TraditionalStaticAssignmentLinkOutputTypeAdapter
Constructor
TraditionalStaticAssignmentODOutputTypeAdapter - Class in org.planit.output.adapter
Adapter providing access to the data of the TraditionalStaticAssignment class relevant for origin-destination outputs without exposing the internals of the traffic assignment class itself
TraditionalStaticAssignmentODOutputTypeAdapter(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.TraditionalStaticAssignmentODOutputTypeAdapter
Constructor
TraditionalStaticAssignmentSimulationData - Class in org.planit.data
Simulation data which are specific to Traditional Static Assignment
TraditionalStaticAssignmentSimulationData(IdGroupingToken, OutputManager) - Constructor for class org.planit.data.TraditionalStaticAssignmentSimulationData
Constructor
TraditionalStaticRouteOutputTypeAdapter - Class in org.planit.output.adapter
Adapter providing access to the data of the TraditionalStaticAssignment class relevant for OD path outputs without exposing the internals of the traffic assignment class itself
TraditionalStaticRouteOutputTypeAdapter(OutputType, TrafficAssignment) - Constructor for class org.planit.output.adapter.TraditionalStaticRouteOutputTypeAdapter
Constructor
trafficAssignment - Variable in class org.planit.output.adapter.OutputTypeAdapterImpl
the traffic assignment this output adapter is drawing from
trafficAssignment - Variable in class org.planit.output.configuration.OutputTypeConfiguration
The traffic assignment object on which this output type configuration is being registered
TrafficAssignment - Class in org.planit.trafficassignment
Traffic assignment class which simultaneously is responsible for the loading hence it is also considered as a traffic assignment component of this type
TrafficAssignment(IdGroupingToken) - Constructor for class org.planit.trafficassignment.TrafficAssignment
Constructor.
trafficAssignmentBuilder - Variable in class org.planit.trafficassignment.TrafficAssignment
The builder for all traffic assignment instances
TrafficAssignmentBuilder - Class in org.planit.trafficassignment.builder
All traffic assignment instances require a network, demand, and (equilibrium) smoothing procedure, all of which should be registered via this generic builder.
TrafficAssignmentComponent<T extends TrafficAssignmentComponent<T> & Serializable> - Class in org.planit.trafficassignment
Traffic assignment components are the main building blocks to conduct traffic assignment on
TrafficAssignmentComponent(IdGroupingToken, Class<?>) - Constructor for class org.planit.trafficassignment.TrafficAssignmentComponent
Constructor
TrafficAssignmentComponentFactory<T extends TrafficAssignmentComponent<T> & Serializable> - Class in org.planit.trafficassignment
Generic factory class for registered subclasses of predefined traffic assignment components, so it does not create instances of T but of sublcasses of T.
TrafficAssignmentComponentFactory(Class<T>) - Constructor for class org.planit.trafficassignment.TrafficAssignmentComponentFactory
Constructor
trafficAssignments - Variable in class org.planit.project.CustomPlanItProject
The registered assignments
trafficAssignmentsMap - Variable in class org.planit.project.CustomPlanItProject.ProjectAssignments
The traffic assignment(s) registered on this project
TRAFFICCOMPONENT_CREATE - Static variable in class org.planit.trafficassignment.TrafficAssignmentComponentFactory
event type fired off when a new traffic assignment component is created
trafficComponentType - Variable in class org.planit.trafficassignment.TrafficAssignmentComponent
Traffic component type used to identify the component uniquely.
transportNetwork - Variable in class org.planit.trafficassignment.TrafficAssignment
The transport network to use which is an adaptor around the physical network and the zoning
TransportNetwork - Class in org.planit.network.transport
Entire transport network that is being modeled including both the physical and virtual aspects of it as well as the zoning.
TransportNetwork(PhysicalNetwork, Zoning) - Constructor for class org.planit.network.transport.TransportNetwork
Constructor
TravelerType - Class in org.planit.userclass
Traveler type is a placeholder for all different types of traveler characteristics that affect the user class in the route choice component of traffic assignment.
TravelerType(IdGroupingToken) - Constructor for class org.planit.userclass.TravelerType
Constructor
TravelerType(IdGroupingToken, Object, String) - Constructor for class org.planit.userclass.TravelerType
Constructor
TravelerType(IdGroupingToken, String) - Constructor for class org.planit.userclass.TravelerType
Constructor
travelerTypeExternalIdToTravelerTypeMap - Variable in class org.planit.input.InputBuilderListener
Map which stores traveler type by external Id
travelerTypes - Variable in class org.planit.demands.Demands
internal class instance containing all traveler types on this demand instance
TravelerTypes() - Constructor for class org.planit.demands.Demands.TravelerTypes
Constructor
TriConsumer<T,​U,​V> - Interface in org.planit.utils.functionalinterface
Function Interface which can process three input objects.
TriFunction<R,​S,​T,​U> - Interface in org.planit.utils.functionalinterface
Function Interface which can process three input objects and produce an output Used in PlanItIO test cases.
TriggerEvent - Class in org.planit.ltm.event
A trigger event emanates from a link boundary (its source) with a particular cumulative value and time and potentially other information which should be constructed by subclassing this class
TriggerEvent(EventType, LinkSegmentBoundary, CumulativePoint, Serializable) - Constructor for class org.planit.ltm.event.TriggerEvent
Constructor
TriggerFlowEvent - Class in org.planit.ltm.event
A trigger flow event represents a flow rate that is being triggered exogenously, typically by a node on either side of the link segment.
TriggerFlowEvent(LinkSegmentBoundary, CumulativePoint, double) - Constructor for class org.planit.ltm.event.TriggerFlowEvent
Constructor
turnSendingFlows - Variable in class org.planit.algorithms.nodemodel.TampereNodeModelInput
the turn sending flows offered to the node model t_ab
Type - Enum in org.planit.output.enums
Enumeration of possible output data types

U

Units - Enum in org.planit.output.enums
Enumeration of possible units
unregisterOutputFormatter(OutputFormatter) - Method in class org.planit.output.OutputManager
Remove an output formatter which has previously been registered
unregisterOutputFormatter(OutputFormatter) - Method in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Remove an output formatter which has already been registered This is used by the Python interface, which registers the PlanItIO formatter by default
unregisterOutputFormatter(OutputFormatter) - Method in class org.planit.trafficassignment.TrafficAssignment
Unregister an output formatter
update(int) - Method in class org.planit.sdinteraction.smoothing.MSASmoothing
Update stepSize to 1/iterationIndex
update(int) - Method in class org.planit.sdinteraction.smoothing.Smoothing
Determine the stepsize for the passed in iteraction
updateCapacityConstrainedInLinkSegments(Pair<Double, Integer>) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Based on the most restricting out-link segment, determine the flow acceptance factor for all unprocessed in-link with non-zero (remaining) flows towards this out-link segment
updateCurrentLocation() - Method in class org.planit.od.ODDataIteratorImpl
Increment the location cursor for the next iteration
updateDemandConstrainedInLinkSegments(Pair<Double, Integer>) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
 
updateRemainingReceivingAndSendingFlows(long) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Remove all turn sending flows from provided in-link from remaining receiving flows (whichever out-link they go to) for a demand constrained in link R_b' = R_b'-t_ab' for all out links b' t_ab' = 0 (to ensure the turn flows are not accidentally reused when updating lambda in next iteration)
updateRemainingReceivingAndSendingFlows(long, double) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Remove all accepted turn sending flows (by scaling with flow acceptance factor) from provided in-link from remaining receiving flows (whichever out-link they go to) R_b' = R_b'-alpha_a*t_ab' for all out links b' t_ab' = 0 (to ensure the turn flows are not accidentally reused when updating lambda in next iteration)
updateSets(Pair<Double, Integer>) - Method in class org.planit.algorithms.nodemodel.TampereNodeModel
Based on the outlink segment, we determine which in links are demand constrained (if any).
UpdateZoning - Class in org.planit.io.xml.zoning
This class contains methods to update the Zoning object using input values from the XML zoning input file.
UpdateZoning() - Constructor for class org.planit.io.xml.zoning.UpdateZoning
 
UPSTREAM - org.planit.ltm.LinkSegmentBoundary.Location
 
UPSTREAM_NODE_EXTERNAL_ID - org.planit.output.property.OutputProperty
 
UPSTREAM_NODE_ID - org.planit.output.property.OutputProperty
 
UPSTREAM_NODE_LOCATION - org.planit.output.property.OutputProperty
 
UpstreamNodeExternalIdOutputProperty - Class in org.planit.output.property
 
UpstreamNodeExternalIdOutputProperty() - Constructor for class org.planit.output.property.UpstreamNodeExternalIdOutputProperty
 
UpstreamNodeIdOutputProperty - Class in org.planit.output.property
 
UpstreamNodeIdOutputProperty() - Constructor for class org.planit.output.property.UpstreamNodeIdOutputProperty
 
UpstreamNodeLocationOutputProperty - Class in org.planit.output.property
 
UpstreamNodeLocationOutputProperty() - Constructor for class org.planit.output.property.UpstreamNodeLocationOutputProperty
 
upstreamVertex - Variable in class org.planit.graph.EdgeSegmentImpl
the upstreamVertex of the edge segment
UserClass - Class in org.planit.userclass
A user class defines a combination of one or more characteristics of users in an aggregate representation of traffic which partially dictate how they behave in traffic assignment.
UserClass(IdGroupingToken, Object, String, Mode, TravelerType) - Constructor for class org.planit.userclass.UserClass
Constructor of user class
userClasses - Variable in class org.planit.demands.Demands
internal class instance containing all user classes on this demand instance
UserClasses() - Constructor for class org.planit.demands.Demands.UserClasses
Constructor
userClassExternalIdToUserClassMap - Variable in class org.planit.input.InputBuilderListener
Map which stores user class by external Id

V

validateAndFilterKeyProperties(OutputProperty[]) - Method in class org.planit.output.configuration.LinkOutputTypeConfiguration
Validate whether the specified list of keys is valid, and if it is return only the keys which will be used
validateAndFilterKeyProperties(OutputProperty[]) - Method in class org.planit.output.configuration.OriginDestinationOutputTypeConfiguration
Validate whether the specified list of keys is valid, and if it is return only the keys which will be used
validateAndFilterKeyProperties(OutputProperty[]) - Method in class org.planit.output.configuration.OutputTypeConfiguration
Validate whether the specified list of keys is valid, and if it is return only the keys which will be used
validateAndFilterKeyProperties(OutputProperty[]) - Method in class org.planit.output.configuration.PathOutputTypeConfiguration
Validate whether the specified list of keys is valid, and if it is return only the keys which will be used
validateXml(String, String) - Static method in interface org.planit.io.xml.util.XmlUtils
Method to validate an XML input file against an XSD schema using Java XML Validator
validateXmlInputFile(String, String) - Static method in class org.planit.io.input.PlanItInputBuilder
Validates an input XML file against an XSD file
value() - Method in enum org.planit.output.enums.ODSkimSubOutputType
 
value() - Method in enum org.planit.output.enums.OutputTimeUnit
 
value() - Method in enum org.planit.output.enums.OutputType
 
value() - Method in interface org.planit.output.enums.OutputTypeEnum
 
value() - Method in enum org.planit.output.enums.Type
 
value() - Method in enum org.planit.output.enums.Units
 
value() - Method in enum org.planit.output.property.OutputProperty
Return the String value associated with this enumeration value (the fully qualified class name)
value() - Method in enum org.planit.output.property.OutputPropertyPriority
Return the String value associated with this enumeration value (the fully qualified class name)
valueOf(String) - Static method in enum org.planit.ltm.LinkSegmentBoundary.Location
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.ODSkimSubOutputType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.OutputTimeUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.OutputType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.RouteIdType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.enums.Units
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.property.OutputProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.planit.output.property.OutputPropertyPriority
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.planit.ltm.LinkSegmentBoundary.Location
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.ODSkimSubOutputType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.OutputTimeUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.OutputType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.RouteIdType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.enums.Units
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.property.OutputProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.planit.output.property.OutputPropertyPriority
Returns an array containing the constants of this enum type, in the order they are declared.
VC_RATIO - org.planit.output.property.OutputProperty
 
VCRatioOutputProperty - Class in org.planit.output.property
Calculate V/C ratio output property class
VCRatioOutputProperty() - Constructor for class org.planit.output.property.VCRatioOutputProperty
 
VEH_H - org.planit.output.enums.Units
 
VEH_KM - org.planit.output.enums.Units
 
verifyComponentCompatibility() - Method in class org.planit.trafficassignment.TrafficAssignment
Verify if the traffic assignment components are compatible and nonnull
Vertex - Interface in org.planit.utils.graph
Vertex representation connected to one or more edges
Vertex.Edges - Interface in org.planit.utils.graph
edges of this vertex
Vertex.EdgeSegments - Interface in org.planit.utils.graph
EdgeSegment container
vertexA - Variable in class org.planit.graph.EdgeImpl
Vertex A
vertexB - Variable in class org.planit.graph.EdgeImpl
Vertex B
VertexImpl - Class in org.planit.graph
Node representation connected to one or more entry and exit links
VertexImpl(IdGroupingToken) - Constructor for class org.planit.graph.VertexImpl
Constructor
VertexImpl.EdgeSegmentsImpl - Class in org.planit.graph
EdgeSegment container
VertexImpl.EdgesImpl - Class in org.planit.graph
edges of this vertex
virtualCost - Variable in class org.planit.trafficassignment.TrafficAssignment
The virtual cost function
VirtualCost - Class in org.planit.cost.virtual
Object to handle the travel time cost of a virtual link
VirtualCost(IdGroupingToken) - Constructor for class org.planit.cost.virtual.VirtualCost
Constructor
virtualCostFactory - Variable in class org.planit.trafficassignment.builder.TrafficAssignmentBuilder
Cost factory to create physical costs to register on the generalized cost.
virtualNetwork - Variable in class org.planit.network.virtual.Zoning
Virtual network holds all the virtual connections to the physical network
VirtualNetwork - Class in org.planit.network.virtual
Model free virtual network which is part of the zoning and holds all the virtual infrastructure connecting the zones to the physical road network.
VirtualNetwork(IdGroupingToken) - Constructor for class org.planit.network.virtual.VirtualNetwork
Constructor
VirtualNetwork.Centroids - Class in org.planit.network.virtual
Internal class for all Centroid specific code
VirtualNetwork.Connectoids - Class in org.planit.network.virtual
Internal class for all Connectoid specific code
VirtualNetwork.ConnectoidSegments - Class in org.planit.network.virtual
Internal class for non-physical LinkSegment specific code, i.e.

W

writeGeneralResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Write General results for the current time period to the CSV file
writeGeneralResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write General results for the current time period to the CSV file
writeGeneralResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Write General results for the current time period to the CSV file
writeLinkResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Write link results for the current time period to the CSV file
writeLinkResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write link results for the current time period to the CSV file
writeLinkResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Write link results for the current time period to Map in memory
writeLinkResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, CSVPrinter) - Method in class org.planit.output.formatter.CsvFileOutputFormatter
Write output values to the Link CSV file for the current iteration
writeOdResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Write Origin-Destination results for the time period to the CSV file
writeOdResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write Origin-Destination results for the time period to the CSV file
writeOdResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Write Origin-Destination results for the time period to the Map in memory
writeOdResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, CSVPrinter) - Method in class org.planit.output.formatter.CsvFileOutputFormatter
Write output values to the OD CSV file for the current iteration
writePathResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Write Path results for the time period to the CSV file
writePathResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write OD Path results for the time period to the CSV file
writePathResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Write Path results for the time period to the CSV file
writePathResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, CSVPrinter) - Method in class org.planit.output.formatter.CsvFileOutputFormatter
Write output values to the Path CSV file for the current iteration
writeSimulationResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.io.output.formatter.PlanItOutputFormatter
Write Simulation results for the current time period to the CSV file
writeSimulationResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.BaseOutputFormatter
Write Simulation results for the current time period to the CSV file
writeSimulationResultsForCurrentTimePeriod(OutputConfiguration, OutputTypeConfiguration, OutputTypeEnum, OutputAdapter, Set<Mode>, TimePeriod, int) - Method in class org.planit.output.formatter.MemoryOutputFormatter
Write Simulation results for the current time period to the CSV file

X

XmlTextFileOutputFormatter - Interface in org.planit.output.formatter
This interfaces defines behaviours which output formatters which generate an XML output file must have.
XmlUtils - Interface in org.planit.io.xml.util
Utility methods for parsing XML data

Z

Zone - Interface in org.planit.utils.network.virtual
Zone represent a geographical area with a centroid which in turn represent the single point of departure of all traffic in the zone
ZoneImpl - Class in org.planit.network.virtual
Represents a demand generating zone in the network.
ZoneImpl(IdGroupingToken, Object) - Constructor for class org.planit.network.virtual.ZoneImpl
Constructor
ZoneImpl(IdGroupingToken, Object, Centroid) - Constructor for class org.planit.network.virtual.ZoneImpl
Constructor
zoneMap - Variable in class org.planit.network.virtual.Zoning
Map storing all the zones by their row/column in the OD matrix
zones - Variable in class org.planit.network.virtual.Zoning
provide access to zones of this zoning
zones - Variable in class org.planit.od.ODDataImpl
holder for zones considered in the matrix
zones - Variable in class org.planit.od.ODDataIteratorImpl
Zones object to store travel analysis zones (from Zoning object)
Zones() - Constructor for class org.planit.network.virtual.Zoning.Zones
 
zoning - Variable in class org.planit.network.transport.TransportNetwork
Holds the zoning structure and virtual transport network interfacing with the physical network
Zoning - Class in org.planit.network.virtual
Zoning class which holds a particular zoning
Zoning(IdGroupingToken, IdGroupingToken) - Constructor for class org.planit.network.virtual.Zoning
Constructor The second id generation token should be the token used by the physical network to create physical network entities such as links, nodes, etc.
Zoning.Zones - Class in org.planit.network.virtual
Internal class for all zone specific code
zoningFactory - Variable in class org.planit.project.PlanItProjectInput
Object factory for zoning objects
zonings - Variable in class org.planit.project.CustomPlanItProject
The registered zonings
zonings - Variable in class org.planit.project.PlanItProjectInput
The registered zonings
zoningsMap - Variable in class org.planit.project.PlanItProjectInput
The zonings registered on this project
A B C D E F G H I K L M N O P Q R S T U V W X Z 
All Classes All Packages