Uses of Class
org.goplanit.component.PlanitComponent

Packages that use PlanitComponent

Package	Description
org.goplanit.assignment	Traffic assignment classes
org.goplanit.assignment.algorithmb
org.goplanit.assignment.ltm
org.goplanit.assignment.ltm.eltm
org.goplanit.assignment.ltm.sltm
org.goplanit.assignment.traditionalstatic
org.goplanit.component
org.goplanit.component.event
org.goplanit.cost.physical	Contains the definition of physical cost classes
org.goplanit.cost.physical.initial	Initial Physical Cost objects
org.goplanit.cost.virtual	Contains the definitions of virtual cost classes
org.goplanit.demands	Classes which manage traveler demands
org.goplanit.gap	Gap functions and criteria used to test for convergence of the assignment algorithms
org.goplanit.network
org.goplanit.network.virtual	Virtual network component object classes
org.goplanit.osm.physical.network.macroscopic
org.goplanit.path	PLANit path classes
org.goplanit.path.choice	PLANit path choice classes
org.goplanit.path.choice.logit	PLANit logit based path choice classes
org.goplanit.project	PLANit project classes
org.goplanit.sdinteraction.smoothing	Classes which perform the smoothing used in the algorithm convergence
org.goplanit.service.routed
org.goplanit.supply.fundamentaldiagram	Fundamental diagram classes
org.goplanit.supply.network.nodemodel	Node model classes
org.goplanit.supply.networkloading	Network loading classes
org.goplanit.zoning

Uses of PlanitComponent in org.goplanit.assignment

Subclasses of PlanitComponent in org.goplanit.assignment

Modifier and Type	Class	Description
class	StaticTrafficAssignment	A static traffic assignment class with some commonalities implemented shared across static assignment implementations
class	TrafficAssignment	Traffic assignment class which simultaneously is responsible for the loading hence it is also considered as a traffic assignment component of this type

Methods in org.goplanit.assignment with parameters of type PlanitComponent

Modifier and Type	Method	Description
protected void	TrafficAssignment.registerComponent(Class<? extends PlanitComponent<?>> componentKey, PlanitComponent<?> component)	Register a PLANit component on this assignment

Method parameters in org.goplanit.assignment with type arguments of type PlanitComponent

Modifier and Type	Method	Description
protected void	TrafficAssignment.registerComponent(Class<? extends PlanitComponent<?>> componentKey, PlanitComponent<?> component)	Register a PLANit component on this assignment

Uses of PlanitComponent in org.goplanit.assignment.algorithmb

Subclasses of PlanitComponent in org.goplanit.assignment.algorithmb

Modifier and Type	Class	Description
class	AlgorithmB	Algorithm B implementation based on the work of Dial (2006).

Uses of PlanitComponent in org.goplanit.assignment.ltm

Subclasses of PlanitComponent in org.goplanit.assignment.ltm

Modifier and Type	Class	Description
class	LtmAssignment	Link Transmission Model implementation base implementation for network loading based on LTM network loading paradigm.

Uses of PlanitComponent in org.goplanit.assignment.ltm.eltm

Subclasses of PlanitComponent in org.goplanit.assignment.ltm.eltm

Modifier and Type	Class	Description
class	EventBasedLtm	Event based Link Transmission Model implementation (eLTM) for network loading using a capacity constrained (Deterministic) assignment

Uses of PlanitComponent in org.goplanit.assignment.ltm.sltm

Subclasses of PlanitComponent in org.goplanit.assignment.ltm.sltm

Modifier and Type	Class	Description
class	StaticLtm	Static Link Transmission Model implementation (sLTM) for network loading based on solution method presented in Raadsen and Bliemer (2021) General solution scheme for the Static Link Transmission Model .

Uses of PlanitComponent in org.goplanit.assignment.traditionalstatic

Subclasses of PlanitComponent in org.goplanit.assignment.traditionalstatic

Modifier and Type	Class	Description
class	TraditionalStaticAssignment	Traditional static assignment traffic component.This is the class that conducts the actual assignment.

Uses of PlanitComponent in org.goplanit.component

Classes in org.goplanit.component with type parameters of type PlanitComponent

Modifier and Type	Class	Description
class	PlanitComponent<T extends PlanitComponent<T> & Serializable>	PLANit components are the main building blocks to create PLANit applications with.
class	PlanitComponentFactory<T extends PlanitComponent<?>>	Generic factory class for registered subclasses of predefined PLANit components, so it does not create instances of T but of subclasses of T.

Methods in org.goplanit.component with type parameters of type PlanitComponent

Modifier and Type	Method	Description
static <C extends PlanitComponent<?>> C	PlanitComponentFactory.create(Class<C> clazzCategory, String concreteClassCanonicalName, Object[] constructorParameters)	Simplified factory method which creates the component (without any listeners)
<C extends PlanitComponent<?>> C	PlanitComponentFactory.create(String planitComponentClassName, Object[] constructorParameters)	Create PLANit component
<C extends PlanitComponent<?>> C	PlanitComponentFactory.create(String planitComponentClassName, Object[] constructorParameters, Object... eventParameters)	Create PLANit component
static <C extends PlanitComponent<?>,U extends C> U	PlanitComponentFactory.createWithListeners(Class<C> clazzCategory, Class<U> concreteClass, Object[] constructorParameters, Object[] eventParameters, PlanitComponentListener... listeners)	Simplified factory method which creates the component, registers the provided listeners for the temporary factory instance component and then invokes the creation with those listeners as a one-off call
static <C extends PlanitComponent<?>,U extends C> U	PlanitComponentFactory.createWithListeners(Class<C> clazzCategory, Class<U> concreteClass, Object[] constructorParameters, PlanitComponentListener... listeners)	Simplified factory method which creates the component, registers the provided listeners for the temporary factory instance component and then invokes the creation with those listeners as a one-off call
static <C extends PlanitComponent<?>> C	PlanitComponentFactory.createWithListeners(Class<C> clazzCategory, String concreteClassCanonicalName, Object[] constructorParameters, Object[] eventParameters, PlanitComponentListener... listeners)	Simplified factory method which creates the component, registers the provided listeners for the temporary factory instance component and then invokes the creation with those listeners as a one-off call
static <C extends PlanitComponent<?>> C	PlanitComponentFactory.createWithListeners(Class<C> clazzCategory, String concreteClassCanonicalName, Object[] constructorParameters, PlanitComponentListener... listeners)	Simplified factory method which creates the component, registers the provided listeners for the temporary factory instance component and then invokes the creation with those listeners as a one-off call

Methods in org.goplanit.component that return PlanitComponent

Modifier and Type	Method	Description
abstract PlanitComponent<T>	PlanitComponent.deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
abstract PlanitComponent<T>	PlanitComponent.shallowClone()	Create a shallow copy of this entity

Method parameters in org.goplanit.component with type arguments of type PlanitComponent

Modifier and Type	Method	Description
static void	PlanitComponentFactory.registerPlanitComponentType(Class<? extends PlanitComponent<?>> planitComponent)	Register a component type that one can choose for the given PLANit component

Constructors in org.goplanit.component with parameters of type PlanitComponent

Constructor	Description
PlanitComponent(PlanitComponent<T> other, boolean deepCopy)	Copy constructor

Uses of PlanitComponent in org.goplanit.component.event

Methods in org.goplanit.component.event that return PlanitComponent

Modifier and Type	Method	Description
PlanitComponent<?>	PopulateComponentEvent.getComponentToPopulate()	collect PLANit component to populate
protected PlanitComponent<?>	PopulateUntypedComponentEvent.getComponentToPopulate()	collect PLANit component to populate

Constructors in org.goplanit.component.event with parameters of type PlanitComponent

Constructor	Description
PopulateComponentEvent(PlanitComponentFactory<?> source, PlanitComponent<?> componentToPopulate, Object[] additionalContent)	Constructor
PopulateUntypedComponentEvent(PlanitComponentEventType type, PlanitComponentFactory<?> source, PlanitComponent<?> componentToPopulate)	Constructor
PopulateUntypedComponentEvent(PlanitComponentEventType type, PlanitComponentFactory<?> source, PlanitComponent<?> componentToPopulate, Object additionalContent)	Constructor
PopulateUntypedComponentEvent(PlanitComponentEventType type, PlanitComponentFactory<?> source, PlanitComponent<?> componentToPopulate, Object[] additionalContent)	Constructor

Uses of PlanitComponent in org.goplanit.cost.physical

Subclasses of PlanitComponent in org.goplanit.cost.physical

Modifier and Type	Class	Description
class	AbstractPhysicalCost	Class for dynamic cost functions, which calculate link segment costs for each iteration and assumes an underlying macroscopic link segment approach
class	BprLinkTravelTimeCost	Well known BPR link performance function to compute travel time cost on link segment based on flow and configuration parameters.
class	FreeFlowLinkTravelTimeCost	Simplest possible travel time cost, namely fixed to free flow travel time regardless of the flows measured.
class	SteadyStateTravelTimeCost	Cost computation for travel times based on the work of Raadsen and Bliemer (2019), Steady-state link travel time methods: Formulation, derivation, classification, and unification.

Uses of PlanitComponent in org.goplanit.cost.physical.initial

Subclasses of PlanitComponent in org.goplanit.cost.physical.initial

Modifier and Type	Class	Description
class	FixedInitialMacroscopicLinkSegmentCost	Initial Link Segment Cost for which all the link segments have the same cost value for a specified mode
class	InitialMacroscopicLinkSegmentCost	Initial Link Segment Costs stored by mode
class	InitialPhysicalCost	The initial physical costs for the network

Uses of PlanitComponent in org.goplanit.cost.virtual

Subclasses of PlanitComponent in org.goplanit.cost.virtual

Modifier and Type	Class	Description
class	AbstractVirtualCost	Object to handle the travel time cost of a virtual link
class	FixedConnectoidTravelTimeCost	Class holding fixed connectoid costs for each connectoid segment
class	SpeedConnectoidTravelTimeCost	Class to calculate the connectoid travel time using connectoid speed

Uses of PlanitComponent in org.goplanit.demands

Subclasses of PlanitComponent in org.goplanit.demands

Modifier and Type	Class	Description
class	Demands	Container class for all demands registered on the project.

Uses of PlanitComponent in org.goplanit.gap

Subclasses of PlanitComponent in org.goplanit.gap

Modifier and Type	Class	Description
class	GapFunction	Abstract base class for gap functions
class	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
class	NormBasedGapFunction	Gap function based on the norm, e.g.

Uses of PlanitComponent in org.goplanit.network

Subclasses of PlanitComponent in org.goplanit.network

Modifier and Type	Class	Description
class	LayeredNetwork<U extends NetworkLayer,T extends NetworkLayers<U>>	A transport network with one or more layers.
class	MacroscopicNetwork	Macroscopic Network which stores one or more macroscopic network infrastructure layers that together form the complete (intermodal) network.
class	Network	Base class for any network.
class	ServiceNetwork	A service network is a network built on top of a topological (physical) transport network providing services leveraging this underlying network.
class	TopologicalLayerNetwork<T extends TopologicalLayer,U extends TopologicalLayers<T>>	A network with topological transport layers, meaning that apart from representing a physical reality the result is topologically meaningful, has nodes, links, and some geographic notion via a coordinate reference system
class	UntypedPhysicalNetwork<L extends UntypedPhysicalLayer<?,?,?>,LS extends UntypedPhysicalNetworkLayers<L>>	A network that comprises physical topological transport network elements, i.e., roads, rail, etc.

Uses of PlanitComponent in org.goplanit.network.virtual

Subclasses of PlanitComponent in org.goplanit.network.virtual

Modifier and Type	Class	Description
class	VirtualNetworkImpl	Model free virtual network which is part of the zoning and holds all the virtual infrastructure connecting the zones to the physical road network.

Uses of PlanitComponent in org.goplanit.osm.physical.network.macroscopic

Subclasses of PlanitComponent in org.goplanit.osm.physical.network.macroscopic

Modifier and Type	Class	Description
class	PlanitOsmNetwork	Macroscopic network with additional OSM functionality Disclaimer: The descriptions for the default OSM link segment types have been copied from the OSM Wiki

Uses of PlanitComponent in org.goplanit.path

Subclasses of PlanitComponent in org.goplanit.path

Modifier and Type	Class	Description
class	OdPathSets	Contains one or more origin-destination based path sets that can be used in assignment.

Uses of PlanitComponent in org.goplanit.path.choice

Subclasses of PlanitComponent in org.goplanit.path.choice

Modifier and Type	Class	Description
class	PathChoice	The path choice traffic assignment component responsible for the configuration of the path choice methodology and the path associated with this procedure.
class	StochasticPathChoice	Stochastic path choice component.

Uses of PlanitComponent in org.goplanit.path.choice.logit

Subclasses of PlanitComponent in org.goplanit.path.choice.logit

Modifier and Type	Class	Description
class	LogitChoiceModel	The logit choice model base class.
class	MultinomialLogit	MNL choice model implementation

Uses of PlanitComponent in org.goplanit.project

Method parameters in org.goplanit.project with type arguments of type PlanitComponent

Modifier and Type	Method	Description
void	CustomPlanItProject.registerEligibleTrafficComponentClass(Class<? extends PlanitComponent<?>> theClazz)	Register a class that we allow to be instantiated as a concrete implementation of a traffic assignment component that can be used in PLANit

Uses of PlanitComponent in org.goplanit.sdinteraction.smoothing

Subclasses of PlanitComponent in org.goplanit.sdinteraction.smoothing

Modifier and Type	Class	Description
class	MSASmoothing	MSA smoothing object
class	Smoothing	Smoothing class to smooth data, such as path flows or other types of flows or traffic data between iterations

Uses of PlanitComponent in org.goplanit.service.routed

Subclasses of PlanitComponent in org.goplanit.service.routed

Modifier and Type	Class	Description
class	RoutedServices	Routed services are service that follow a predefined paths (route) on a service network layer that are offered as a service of some sort, i.e., it either follows a schedule or a frequency.

Methods in org.goplanit.service.routed that return PlanitComponent

Modifier and Type	Method	Description
PlanitComponent<RoutedServices>	RoutedServices.deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
PlanitComponent<RoutedServices>	RoutedServices.shallowClone()	Create a shallow copy of this entity

Uses of PlanitComponent in org.goplanit.supply.fundamentaldiagram

Subclasses of PlanitComponent in org.goplanit.supply.fundamentaldiagram

Modifier and Type	Class	Description
class	FundamentalDiagramComponent	Fundamental diagram traffic component.
class	NewellFundamentalDiagramComponent	Newell fundamental diagram traffic component

Uses of PlanitComponent in org.goplanit.supply.network.nodemodel

Subclasses of PlanitComponent in org.goplanit.supply.network.nodemodel

Modifier and Type	Class	Description
class	NodeModelComponent	Node model traffic component
class	TampereNodeModelComponent	Tampere node model traffic component signalling that the Tampere node model algorithm is to be used

Uses of PlanitComponent in org.goplanit.supply.networkloading

Subclasses of PlanitComponent in org.goplanit.supply.networkloading

Modifier and Type	Class	Description
class	NetworkLoading	Network loading traffic component

Uses of PlanitComponent in org.goplanit.zoning

Subclasses of PlanitComponent in org.goplanit.zoning

Modifier and Type	Class	Description
class	Zoning	Zoning class which holds a particular zoning