All Classes

Class	Description
AbstractPhysicalCost	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).
ArgumentParser	This class parses program arguments and returns them as a map of file types and file locations.
ArrayOperations	General methods for updating arrays
BaseOutputFormatter	Base class for all formatters of output data, i.e.
BaseOutputProperty	Template for output property classes which can be included in the output files.
BPRLinkTravelTimeCost	Well known BPR link performance function to compute travel time cost on link segment based on flow and configuration parameters.
CalculatedSpeedOutputProperty	Calculate speed output property class
CapacityConstrainedAssignment	Capacity constrained traffic assignment component
CapacityConstrainedTrafficAssignmentBuilder	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.
CapacityPerLaneOutputProperty
Centroid	A centroid is a special type of vertex representing the location of departure/arrival of traffic in a zone
CentroidImpl	Centroid implementation
Configurator<T>	This is the base class for all configuration oriented proxy classes.
Connectoid	the connecting component between centroid and a first physical node in the network.
ConnectoidImpl	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.
ConnectoidSegment	Connectoid segment represents a directional virtual segment connecting a centroid and a physical node.
ConnectoidSegmentImpl	The link segment that connects a zone to the physical network is not a physical link segment.
Cost<T extends EdgeSegment>	Cost of an EdgeSegment
CostTimesFlowOutputProperty	Cost times flow output property class
CsvFileOutputFormatter	Class containing common methods required by classes which write results to CSV output files
CsvTextFileOutputFormatter	This interfaces defines behaviours which output formatters which generate a CSV output file must have.
CumulativeEvent	A cumulative event represents a cumulative pcu point in space-time with (potential) additional information.
CumulativePoint	Represents a cumulative point in time
CumulativePointImpl	Represents a cumulative point in time
CustomPlanItProject	The top-level class which hosts a single project.
Demands	Container class for all demands registered on the project.
DemandsPopulator	This class contains methods to populate the Demands object using input values from the XML demands input file.
DensityOutputProperty
DestinationZoneExternalIdOutputProperty
DestinationZoneIdOutputProperty
DijkstraShortestPathAlgorithm	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).
DownstreamNodeExternalIdOutputProperty
DownstreamNodeIdOutputProperty
DownstreamNodeLocationOutputProperty
DynamicTrafficAssignment	Dynamic traffic assignment class for any traffic assignment model that adheres to being capacity constrained utilizing a fundamental diagram and underlying node model
DynamicTrafficAssignmentBuilder	A dynamic traffic assignment builder is assumed to only support capacity constrained traffic assignment instances.
Edge	Edge interface connecting two vertices in a non-directional fashion.
EdgeImpl	Edge class connecting two vertices via some geometry.
EdgeSegment	EdgeSegment represents an edge in a particular (single) direction.
EdgeSegmentImpl	EdgeSegment represents an edge in a particular (single) direction.
ELTM	event based Link Transmission Model implementation (eLTM) for network loading using a capacity constrained (Deterministic) assignment
ELTMTrafficAssignmentBuilder	The eLTM traffic assignment builder.
EnumConverter	Utility methods to convert enumerations from the PLANit org.planit.output.enums package into enumerations generated from the output XSD file
FileOutputFormatter	Common methods used by output formatters which write data to physical files
FixedConnectoidTravelTimeCost	Class holding fixed connectoid costs for each connectoid segment
FlowOutputProperty
FormatUtils	Utility methods for formatting doubles
FundamentalDiagram	Fundamental diagram traffic component
GapFunction	Interface for computing gap functions
IdGenerator	Convenience class to track unique ids across different classes that decide to use a generator for their id members.
IdGroupingToken	Class used as token to group ids, i.e., ids for a class generated with this token will be unique within this group.
InitialLinkSegmentCost	Initial Link Segment Costs stored by mode
InitialLinkSegmentCostPeriod	Identical to InitialLinkSegmentCost except that it is directly attached to a particular time period.
InitialPhysicalCost	The initial physical costs for the network
InputBuilderListener	Listener which is automatically registered to the creation of any traffic assignment component for which it gets notified.
InteractorAccessee	Interactor accessee.
InteractorAccessor	Interactor accessor.
IterationIndexOutputProperty
LengthOutputProperty
Link	Link interface which extends the Edge interface with a unique id (not all edges are links) as well as an external id
LinkBasedRelativeDualityGapFunction	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
LinkCostOutputProperty
LinkImpl	Link class connecting two nodes via some geometry.
LinkOutputTypeAdapter	Interface defining the methods required for a link output adapter
LinkOutputTypeAdapterImpl	Top-level abstract class which defines the common methods required by Link output type adapters
LinkOutputTypeConfiguration	The configuration for the link output type.
LinkSegment
LinkSegmentBoundary	LinkSegment boundary of a link segment.
LinkSegmentBoundary.Location	Location types for a link segment boundary
LinkSegmentExpectedResultsDto	DTO object containing extra fields specific to BPR function The first
LinkSegmentExternalIdOutputProperty
LinkSegmentIdOutputProperty
LinkSegmentImpl	Link segment object representing physical links in the network and storing their properties
LinkTypeOutputProperty
LinkVolumeAccessee	Link Volume accessee object.
LinkVolumeAccessor	Link Volume Accessor interface
Logging	Utility class to close the current logger
LoggingUtils	some utilities for consistent logging message creation in PLANit
LogitChoiceModel	The logit choice model base class.
MacroscopicLinkSegment	Macroscopic traffic modeling oriented link segment
MacroscopicLinkSegmentImpl	Link segment for macroscopic transport networks.
MacroscopicLinkSegmentType	The macroscopic link segment type characteristics are contained in this class
MacroscopicLinkSegmentTypeImpl	Each macroscopic link segment is of a particular type reflecting segment specific properties.
MacroscopicLinkSegmentTypeXmlHelper	Helper class used to create MacroscopicLinkSegmentType objects for XML input
MacroscopicModeProperties	Contains the properties of a mode specific to a link segment type
MacroscopicModePropertiesImpl	Mode specific properties for the macroscopic perspective on the supply side, i.e.
MacroscopicNetwork	Macroscopic Network which stores link segment types
MacroscopicNetworkBuilder	Create network entities for a macroscopic simulation model
ManualInitialLinkSegmentCost	Initial Link Segment Cost for which all the link segments have the same cost value for a specified mode
MaximumDensityOutputProperty
MaximumSpeedOutputProperty
MemoryOutputFormatter	OutputFormatter which stores data in memory, using specified keys and output properties.
MemoryOutputIterator	Iterator which loops through the keys and values stored in the MemoryOutputFormatter This class is a wrapper for MultiKeyPlanItDataIterator.
Mode	Interface to represent a mode
ModeData	Object to store the flows for each mode during the assignment iterations
ModeExternalIdOutputProperty
ModeIdOutputProperty
ModeImpl	A Mode is a user class feature representing a single form of transport (car, truck etc.).
MSASmoothing	MSA smoothing object
MultiKeyPlanItData	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.
MultiKeyPlanItDataIterator	Iterator which returns the keys and values for each row in a MultiKeyPlanItData object.
MultiKeyPlanItDataIteratorImpl	Implementation of the MultiKeyPlanItDataIterator interface
MultinomialLogit	MNL choice model implementation
NetworkLoading	Network loading traffic component
NewellFundamentalDiagram	Newell fundamental diagram traffic component
Node	Node is a vertex but not all vertices are nodes.
NodeImpl	Node representation connected to one or more entry and exit links
NodeModel	Node model algorithm base class
NodeModel	Node model traffic component
NullaryDoubleSupplier	Lightweight Nullaryfunction implementation to supply doubles in the form of a NullaryFunction<Double> compatible with OjAlgo
NumberOfLanesOutputProperty
ODCostOutputProperty
ODData<T>	Interface defining methods for objects which store data related to origin and destination
ODDataImpl<T>	Base class containing common methods required by all classes which implement ODData
ODDataIterator<T>	Defines methods for an iterator which moves through a matrix of origin-destination cells
ODDataIteratorImpl<T>	Base class containing common methods required by all classes which implement ODDataIterator
ODDemandMatrix	This class handles the OD demand matrix.
ODMatrix	This class contains common methods for handling origin-demand matrices.
ODMatrixIterator	Iterator which runs through rows and columns of an OD matrix, making the value, row and column of each cell available
ODOutputTypeAdapter	Interface defining the methods required for an Origin-Destination output adapter
ODOutputTypeAdapterImpl	Top-level abstract class which defines the common methods required by OD output type adapters
ODRouteIterator	Iterator which runs through rows and columns of a matrix of Path objects, making the Path, row and column of each cell available
ODRouteMatrix	This class stores the route objects from each origin to each destination.
ODRouteSets	Contains one or more origin-destination based route sets that can be used in assignment.
ODSkimMatrix	This class stores an OD Skim matrix.
ODSkimSubOutputType	Enumeration of possible values of OD Skim Output Type
OriginDestinationOutputTypeConfiguration	The configuration for the origin-destination output type.
OriginZoneExternalIdOutputProperty
OriginZoneIdOutputProperty
OutputAdapter	Output Adapter which stores output type adapters for each Output Manager and defines top-level method which apply to all output types
OutputConfiguration	Class containing the general output configuration and the type specific configurations for some traffic assignment
OutputFormatter	Interface for persisting output data in a particular format
OutputFormatterFactory	Factory to create output writers of any compatible type
OutputManager	Base class for output writers containing basic functionality regarding all things output
OutputProperty	Enumeration of possible output properties
OutputPropertyPriority	Enumeration giving the priority of output properties.
OutputTimeUnit
OutputType	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	Top-level interface for all output type adapters
OutputTypeAdapterImpl	Top-level abstract class which defines the common methods required by all output type adapters
OutputTypeConfiguration	Configuration for a specific output type including the adapter allowing access to the underlying raw data
OutputTypeEnum	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
OutputUtils	Utility Functions used during output
Pair<A,B>	Custom pair class similar to C++.
PathIdOutputProperty
PathOutputStringProperty
PathOutputTypeConfiguration	The configuration for the OD path output type.
PhysicalCost	Class for dynamic cost functions, which calculate link segment costs for each iteration
PhysicalNetwork	Model free Network consisting of nodes and links, each of which can be iterated over.
PhysicalNetworkBuilder	Build network elements based on chosen network view.
PiecewiseLinearCumulativeCurve	Represents a piecewise linear cumulative curve
PlanItException	General exception for PlanIt which wraps exceptions thrown during execution
PlanitGeoUtils	General geotools related utils
PlanItInputBuilder	Class which reads inputs from XML input files
PlanItMain	Test class to run XML input files.
PlanItOutputFormatter	The default output formatter of PlanIt
PlanItProject	PLANit project which is nothing more than a CustomPlanItProject without any custom configuration pre-embedded.
PlanItProjectInput	Class that holds all the input traffic components for a PLANit project.
PlanItSimpleProject	Wrapper around PLANitProject with most common defaults automatically activated.
Precision	compare doubles with a certain precision
ProcessConfiguration	Methods to generate and store PLANit configuration objects from the configuration object in the XML demand input file.
ProcessInfrastructure	Process the Infrastructure object populated with data from the XML file
ProcessLinkConfiguration	Process the LinkConfiguration object populated with data from the XML file
QuadConsumer<T,U,V,W>	Function Interface which can process four input objects.
ReflectionUtils	Reflection specific utility functions
ReleaseEvent	A release event represents the arrival of a trigger event at the opposite link boundary from where it originated.
ReleaseFlowEvent	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.
Route	Route interface representing a route through the network on edge segment level
RouteChoice	The route choice traffic assignment component responsible for the configuration of the route choice methodology and the routes associated with this procedure.
RouteChoiceBuilder	The type of Route choice is sometimes but not always a choice for any given traffic assignment model.
RouteIdType	Enumeration of possible Id types used to identify a Route
RouteImpl	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.
RouteOutputTypeAdapter
RouteOutputTypeAdapterImpl	Top-level abstract class which defines the common methods required by Path output type adapters
RunIdOutputProperty
ShortestPathAlgorithm	An algorithm which calculates the shortest (a.k.a.
SimulationData	General simulation data that only are available during simulation
Smoothing	Smoothing class to smooth data, such as path flows or other types of flows or traffic data between iterations
SpeedConnectoidTravelTimeCost	Class to calculate the connectoid travel time using connectoid speed
StackWalkerUtil	Utils class warpping the Stackwalker API functionality in easy to use method calls.
StochasticRouteChoice	Stochastic route choice component.
StopCriterion	StopCriterion class.
SubOutputTypeEnum	Marker interface to indicate enums that are of a subtype of OutputType
TampereNodeModel	General First order node model implementation as proposed by Tampere et al.
TampereNodeModel	Tampere node model traffic component
TampereNodeModelFixedInput	Inner class that holds the mapping of the inputs to/from the underlying physical network (if any).
TampereNodeModelInput	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)
TestOutputDto<A,B,C>	Data Transfer Object used to store results in unit testing for PlanItIO
TimePeriod	Represents a time period within the day.
TimePeriodExternalIdOutputProperty
TimePeriodIdOutputProperty
TraditionalStaticAssignment	Traditional static assignment traffic component.
TraditionalStaticAssignmentBuilder	Builder for a traditional static assignment.
TraditionalStaticAssignmentLinkOutputTypeAdapter	Adapter providing access to the data of the TraditionalStaticAssignment class relevant for link outputs without exposing the internals of the traffic assignment class itself
TraditionalStaticAssignmentODOutputTypeAdapter	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
TraditionalStaticAssignmentSimulationData	Simulation data which are specific to Traditional Static Assignment
TraditionalStaticRouteOutputTypeAdapter	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
TrafficAssignment	Traffic assignment class which simultaneously is responsible for the loading hence it is also considered as a traffic assignment component of this type
TrafficAssignmentBuilder	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>	Traffic assignment components are the main building blocks to conduct traffic assignment on
TrafficAssignmentComponentFactory<T extends TrafficAssignmentComponent<T> & Serializable>	Generic factory class for registered subclasses of predefined traffic assignment components, so it does not create instances of T but of sublcasses of T.
TransportNetwork	Entire transport network that is being modeled including both the physical and virtual aspects of it as well as the zoning.
TravelerType	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.
TriConsumer<T,U,V>	Function Interface which can process three input objects.
TriFunction<R,S,T,U>	Function Interface which can process three input objects and produce an output Used in PlanItIO test cases.
TriggerEvent	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
TriggerFlowEvent	A trigger flow event represents a flow rate that is being triggered exogenously, typically by a node on either side of the link segment.
Type	Enumeration of possible output data types
Units	Enumeration of possible units
UpdateZoning	This class contains methods to update the Zoning object using input values from the XML zoning input file.
UpstreamNodeExternalIdOutputProperty
UpstreamNodeIdOutputProperty
UpstreamNodeLocationOutputProperty
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.
VCRatioOutputProperty	Calculate V/C ratio output property class
Vertex	Vertex representation connected to one or more edges
Vertex.Edges	edges of this vertex
Vertex.EdgeSegments	EdgeSegment container
VertexImpl	Node representation connected to one or more entry and exit links
VirtualCost	Object to handle the travel time cost of a virtual link
VirtualNetwork	Model free virtual network which is part of the zoning and holds all the virtual infrastructure connecting the zones to the physical road network.
XmlTextFileOutputFormatter	This interfaces defines behaviours which output formatters which generate an XML output file must have.
XmlUtils	Utility methods for parsing XML data
Zone	Zone represent a geographical area with a centroid which in turn represent the single point of departure of all traffic in the zone
ZoneImpl	Represents a demand generating zone in the network.
Zoning	Zoning class which holds a particular zoning