Uses of Interface
org.planit.utils.mode.Mode

Packages that use Mode

Package	Description
org.planit.assignment	Traffic assignment classes
org.planit.assignment.algorithmb
org.planit.assignment.traditionalstatic
org.planit.cost	Contains the definitions of cost classes
org.planit.cost.physical	Contains the definition of physical cost classes
org.planit.cost.physical.initial	Initial Physical Cost objects
org.planit.cost.virtual	Contains the definitions of virtual cost classes
org.planit.demands	Classes which manage traveler demands
org.planit.input	Top-level input classes and interfaces
org.planit.io.demands	Classes used to process the Java classes generated from XSD files
org.planit.io.network.converter
org.planit.io.output.formatter	PLANit IO output formatter package
org.planit.io.xml.network	PLANit IO XML parsing for network
org.planit.io.xml.network.physical.macroscopic	PLANit IO XML parsing for macroscopic network
org.planit.mode
org.planit.network
org.planit.network.converter
org.planit.network.macroscopic.physical	Macroscopic physical network component object classes
org.planit.output	output writer related classes
org.planit.output.adapter	Output Adapter and Output Type Adapter classes and interfaces
org.planit.output.formatter	output formatter related classes
org.planit.output.property	Output property objects which represent quantities which can be reported in the output
org.planit.tntp.output.formatter	CSV output formatter used for TNTP results output
org.planit.userclass	Contains the definitions of the user classes (UserClass, TravellerType and Mode)
org.planit.utils.mode
org.planit.utils.network.physical.macroscopic	Macroscopic physical network oriented utility classes
org.planit.utils.zoning	zoning oriented utility classes
org.planit.zoning

Uses of Mode in org.planit.assignment

Method parameters in org.planit.assignment with type arguments of type Mode

Modifier and Type	Method	Description
protected abstract void	StaticTrafficAssignment.executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)	Execute the time period for the registered modes

Uses of Mode in org.planit.assignment.algorithmb

Method parameters in org.planit.assignment.algorithmb with type arguments of type Mode

Modifier and Type	Method	Description
protected void	AlgorithmB.executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)	Execute the time period for the registered modes
void	AlgorithmBEquilibration.executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)	The method that performs the equilibration for a given time period using AlgorithmB

Uses of Mode in org.planit.assignment.traditionalstatic

Methods in org.planit.assignment.traditionalstatic that return types with arguments of type Mode

Modifier and Type	Method	Description
Map<Mode,ModeData>	TraditionalStaticAssignmentSimulationData.getModeSpecificData()	Collect the data per mode for all modes

Methods in org.planit.assignment.traditionalstatic with parameters of type Mode

Modifier and Type	Method	Description
double[]	TraditionalStaticAssignmentSimulationData.getModalLinkSegmentCosts(Mode mode)	Retrieve the link segment costs for a specified mode
ODPathMatrix	TraditionalStaticAssignmentSimulationData.getODPathMatrix(Mode mode)	Retrieve the current OD path for a specified mode
ODSkimMatrix	TraditionalStaticAssignmentSimulationData.getODSkimMatrix(ODSkimSubOutputType odSkimOutputType, Mode mode)	Retrieve the skim matrix for a specified mode and skim output type
Map<ODSkimSubOutputType,ODSkimMatrix>	TraditionalStaticAssignmentSimulationData.getSkimMatrixMap(Mode mode)	Retrieve the Map of OD Skim matrices for all active OD Skim Output Types for a specified mode
void	TraditionalStaticAssignmentSimulationData.resetPathMatrix(Mode mode, Zones<?> zones)	Reset the path matrix to empty for a specified mode for all activated
void	TraditionalStaticAssignmentSimulationData.resetSkimMatrix(Mode mode, Zones<?> zones, ODOutputTypeConfiguration originDestinationOutputTypeConfiguration)	Reset the skim matrix to all zeroes for a specified mode for all activated skim output types
void	TraditionalStaticAssignmentSimulationData.setModalLinkSegmentCosts(Mode mode, double[] modalLinkSegmentCosts)	Set the link segment costs for a specified mode

Method parameters in org.planit.assignment.traditionalstatic with type arguments of type Mode

Modifier and Type	Method	Description
protected void	TraditionalStaticAssignment.executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)	Perform assignment for a given time period using Dijkstra's algorithm

Uses of Mode in org.planit.cost

Methods in org.planit.cost with parameters of type Mode

Modifier and Type	Method	Description
double	Cost.getSegmentCost(Mode mode, T edgeSegment)	Returns the cost of travel along an edge segment for a specified mode

Uses of Mode in org.planit.cost.physical

Methods in org.planit.cost.physical with parameters of type Mode

Modifier and Type	Method	Description
protected double	BPRLinkTravelTimeCost.computeCostInHours(MacroscopicLinkSegment linkSegment, Mode mode, double flowPcuPerHour)	BPR function computation for
Pair<Double,Double>	BPRLinkTravelTimeCost.BPRParameters.getAlphaBetaParameters(Mode mode)	Retrieve Pair containing alpha and beta values for a specified mode
double	BPRLinkTravelTimeCost.getSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment)	Return the travel time for the current link for a given mode If the input data are invalid, this method returns a negative value.
abstract void	AbstractPhysicalCost.populateWithCost(Mode mode, double[] costToFill)	Invoker expects (mode specific ) costs in passed in array to be filled, where each entry signifies a link segment by its id.
void	BPRLinkTravelTimeCost.populateWithCost(Mode mode, double[] costToFill)	populate the cost array with the BPR link travel times for all link segments for the specified mode
void	BPRConfigurator.setDefaultParameters(Mode mode, double alpha, double beta)	Set the default alpha and beta values for a mode
void	BPRConfigurator.setDefaultParameters(MacroscopicLinkSegmentType macroscopicLinkSegmentType, Mode mode, double alpha, double beta)	Set the default alpha and beta values for a given link type and mode
void	BPRLinkTravelTimeCost.setDefaultParameters(Mode mode, double alpha, double beta)	Set the default alpha and beta values for a mode
void	BPRLinkTravelTimeCost.setDefaultParameters(MacroscopicLinkSegmentType macroscopicLinkSegmentType, Mode mode, double alpha, double beta)	Set the default alpha and beta values for a given link type and mode
void	BPRConfigurator.setParameters(MacroscopicLinkSegment linkSegment, Mode mode, double alpha, double beta)	Set the alpha and beta values for a given link segment and mode
void	BPRLinkTravelTimeCost.setParameters(MacroscopicLinkSegment linkSegment, Mode mode, double alpha, double beta)	Set the alpha and beta values for a given link segment and mode

Uses of Mode in org.planit.cost.physical.initial

Methods in org.planit.cost.physical.initial with parameters of type Mode

Modifier and Type	Method	Description
double	InitialLinkSegmentCost.getSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment)	Returns the initial cost for each link segment and mode.
boolean	InitialLinkSegmentCost.isSegmentCostsSetForMode(Mode mode)	Are link segment costs available for the given mode
void	ManualInitialLinkSegmentCost.setAllSegmentCosts(Mode mode, double cost, int noLinkSegments)	Sets a given cost for all link segments for a given mode
void	InitialLinkSegmentCost.setSegmentCost(Mode mode, long linkSegmentId, double cost)	Sets the initial cost for each link segment and mode
void	InitialLinkSegmentCost.setSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment, double cost)	Sets the initial cost for each link segment and mode
abstract void	InitialPhysicalCost.setSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment, double cost)	Set the initial cost for a specified mode and link segment

Uses of Mode in org.planit.cost.virtual

Methods in org.planit.cost.virtual with parameters of type Mode

Modifier and Type	Method	Description
double	FixedConnectoidTravelTimeCost.getSegmentCost(Mode mode, ConnectoidSegment connectoidSegment)	Calculates the connectoid segment cost using a fixed travel time
double	SpeedConnectoidTravelTimeCost.getSegmentCost(Mode mode, ConnectoidSegment connectoidSegment)	Return the connectoid travel time using speed
void	FixedConnectoidTravelTimeCost.populateWithCost(Mode mode, double[] costToFill)
void	SpeedConnectoidTravelTimeCost.populateWithCost(Mode mode, double[] costToFill)
void	VirtualCost.populateWithCost(Mode mode, double[] costToFill)	Invoker expects (mode specific ) costs in passed in array to be filled, where each entry signifies a link segment by its id

Uses of Mode in org.planit.demands

Fields in org.planit.demands with type parameters of type Mode

Modifier and Type	Field	Description
protected TreeMap<Long,TreeMap<Mode,ODDemandMatrix>>	Demands.odDemands	Trip demand matrices

Methods in org.planit.demands that return types with arguments of type Mode

Modifier and Type	Method	Description
Set<Mode>	Demands.getRegisteredModesForTimePeriod(TimePeriod timePeriod)	Get modes registered for the given time period

Methods in org.planit.demands with parameters of type Mode

Modifier and Type	Method	Description
UserClass	Demands.UserClasses.createAndRegisterNewUserClass(String name, Mode mode, TravelerType travellerType)	Factory method to create and register a new user class on the demands
ODDemandMatrix	Demands.get(Mode mode, TimePeriod timePeriod)	Get an ODDemand by mode and time period
ODDemandMatrix	Demands.registerODDemand(TimePeriod timePeriod, Mode mode, ODDemandMatrix odDemandMatrix)	Register provided odDemand

Uses of Mode in org.planit.input

Fields in org.planit.input with type parameters of type Mode

Modifier and Type	Field	Description
protected Map<String,Mode>	InputBuilderListener.sourceIdModeMap	Map which stores Mode xml Ids corresponding to Modes

Methods in org.planit.input that return Mode

Modifier and Type	Method	Description
Mode	InputBuilderListener.getModeBySourceId(String sourceId)	Return Mode for a specified xml Id

Methods in org.planit.input that return types with arguments of type Mode

Modifier and Type	Method	Description
Map<String,Mode>	InputBuilderListener.getAllModesBySourceId()	Return all the registered modes

Methods in org.planit.input with parameters of type Mode

Modifier and Type	Method	Description
protected boolean	InputBuilderListener.addModeToSourceIdMap(String sourceId, Mode mode)	Stores a mode by its sourceId Id

Uses of Mode in org.planit.io.demands

Method parameters in org.planit.io.demands with type arguments of type Mode

Modifier and Type	Method	Description
protected void	PlanitDemandsReader.populateDemandConfiguration(MacroscopicNetwork network, Map<String,Mode> sourceIdModeMap)	Sets up all the configuration data from the XML demands file
void	PlanitDemandsReader.read(MacroscopicNetwork network, Zoning zoning, Map<String,Mode> xmlIdModeMap, Map<String,Zone> xmlIdZoneMap)	parse the Xml and populate the demands memory model

Uses of Mode in org.planit.io.network.converter

Methods in org.planit.io.network.converter that return types with arguments of type Mode

Modifier and Type	Method	Description
Map<String,Mode>	PlanitNetworkReaderSettings.getMapToIndexModeByXmlIds()	exogenous map to index modes by xml id when parsing

Method parameters in org.planit.io.network.converter with type arguments of type Mode

Modifier and Type	Method	Description
void	PlanitNetworkReaderSettings.setMapToIndexModeByXmlIds(Map<String,Mode> modeXmlIdToModeMap)	Use provided map to index modes by xml id when parsing

Uses of Mode in org.planit.io.output.formatter

Method parameters in org.planit.io.output.formatter with type arguments of type Mode

Modifier and Type	Method	Description
protected void	PlanItOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected void	PlanItOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to the CSV file
protected void	PlanItOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the CSV file
protected void	PlanItOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Path results for the time period to the CSV file
protected void	PlanItOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file

Uses of Mode in org.planit.io.xml.network

Method parameters in org.planit.io.xml.network with type arguments of type Mode

Modifier and Type	Method	Description
protected static void	XmlMacroscopicNetworkLayerHelper.parseLinkSegmentTypeModeProperties(org.planit.xml.generated.Accessmode xmlMode, MacroscopicLinkSegmentType linkSegmentType, Map<String,Mode> modesByXmlId)	parse the mode properties for given link segment type and populate the helper with them
static Map<String,MacroscopicLinkSegmentType>	XmlMacroscopicNetworkLayerHelper.parseLinkSegmentTypes(org.planit.xml.generated.XMLElementLayerConfiguration xmlLayerconfiguration, MacroscopicPhysicalNetwork networkLayer, PlanitNetworkReaderSettings settings, Map<String,Mode> modesByXmlId)	parse the link segment types

Uses of Mode in org.planit.io.xml.network.physical.macroscopic

Methods in org.planit.io.xml.network.physical.macroscopic that return types with arguments of type Mode

Modifier and Type	Method	Description
Map<Mode,MacroscopicModeProperties>	MacroscopicLinkSegmentTypeXmlHelper.getModePropertiesMap()

Methods in org.planit.io.xml.network.physical.macroscopic with parameters of type Mode

Modifier and Type	Method	Description
void	MacroscopicLinkSegmentTypeXmlHelper.updateLinkSegmentTypeModeProperties(Object linkTypeExternalId, Mode mode, double maxSpeed, double critSpeed)	Update an existing MacroscopicLinkSegmentTypeXmlHelper

Uses of Mode in org.planit.mode

Classes in org.planit.mode that implement Mode

Modifier and Type	Class	Description
class	BicycleMode	the predefined bicycle mode name: bicycle maxspeed (km/h): 15 pcu: 0.2 vehicular type: VEHICULAR motorisation: NON_MOTORISED track: ROAD use: PRIVATE
class	BusMode	the predefined bus mode name: bus maxspeed (km/h): 100 pcu: 2 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: PUBLIC
class	CarHighOccupancyMode	the predefined car hov mode name: car_hov maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: HIGH_OCCUPANCY
class	CarMode	the predefined car mode name: car maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: PRIVATE
class	CarShareMode	the predefined car share mode name: car maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: RIDE_SHARE
class	GoodsMode	the predefined goods vehicle mode, i.e., truck below 3.5 tonnes name: gv maxspeed (km/h): 100 pcu: 1.8 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: GOODS
class	HeavyGoodsMode	the predefined heavy goods vehicle mode, i.e., truck over 3.5 tonnes name: hgv maxspeed (km/h): 90 pcu: 2.5 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: GOODS
class	LargeHeavyGoodsMode	the predefined large heavy goods vehicle mode, i.e., large articulated truck, larger than heavy goods name: lhgv maxspeed (km/h): 90 pcu: 3 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: GOODS
class	LightRailMode	the predefined lightrail mode name: lightrail maxspeed (km/h): 70 pcu: 6 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLIC
class	ModeImpl	A Mode is a user class feature representing a single form of transport (car, truck etc.).
class	MotorBikeMode	the predefined motor bike mode name: bicycle maxspeed (km/h): 130 pcu: 0.5 vehicular type: VEHICULAR motorisation: NON_MOTORISED track: ROAD use: PRIVATE
class	PedestrianMode	the predefined pedestrian mode name: pedestrian maxspeed (km/h): 5 pcu: 0.1 vehicular type: NO_VEHICLE motorisation: NON_MOTORISED track: ROAD use: PRIVATE
class	PredefinedModeImpl	A mode that has predefined fixed values so it can easily be understood, or mapped
class	SubwayMode	the predefined subway mode name: subway maxspeed (km/h): 60 pcu: 6 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLIC
class	TrainMode	the predefined train mode name: train maxspeed (km/h): 140 pcu: 10 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLIC
class	TramMode	the predefined tram mode name: tram maxspeed (km/h): 40 pcu: 3 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLIC

Methods in org.planit.mode that return Mode

Modifier and Type	Method	Description
Mode	ModesImpl.get(long id)	Return a Mode by its id
Mode	ModesImpl.getByXmlId(String xmlId)	Retrieve a Mode by its xml Id This method is not efficient, since it loops through all the registered modes in order to find the required mode.
Mode	ModesImpl.getFirst()	Collect the first registered mode
protected Mode	ModesImpl.register(Mode mode)	Add mode to the internal container
Mode	ModesImpl.registerNewCustomMode(String name, double maxSpeed, double pcu, PhysicalModeFeatures physicalFeatures, UsabilityModeFeatures usabilityFeatures)	Create and register new mode

Methods in org.planit.mode that return types with arguments of type Mode

Modifier and Type	Method	Description
Iterator<Mode>	ModesImpl.iterator()	Iterator over available modes
Set<Mode>	ModesImpl.setOf()	Provide all modes as a set.

Methods in org.planit.mode with parameters of type Mode

Modifier and Type	Method	Description
protected Mode	ModesImpl.register(Mode mode)	Add mode to the internal container

Uses of Mode in org.planit.network

Fields in org.planit.network with type parameters of type Mode

Modifier and Type	Field	Description
protected Map<Mode,String>	InfrastructureLayersConfigurator.modeToLayerXmlId	track mode to layer mapping
protected Map<Long,Mode>	InfrastructureLayerImpl.supportedModes	the modes supported by this layer

Methods in org.planit.network that return types with arguments of type Mode

Modifier and Type	Method	Description
Collection<Mode>	InfrastructureLayer.getSupportedModes()	collect the modes supported by this infrastructure layer
Collection<Mode>	InfrastructureLayerImpl.getSupportedModes()	collect the modes supported by this infrastructure layer

Methods in org.planit.network with parameters of type Mode

Modifier and Type	Method	Description
InfrastructureLayer	InfrastructureLayers.get(Mode mode)	Find the layer that supports the passed in mode.
InfrastructureLayer	InfraStructureLayersImpl.get(Mode mode)	Find the layer that supports the passed in mode.
InfrastructureLayer	InfrastructureNetwork.getInfrastructureLayerByMode(Mode mode)	collect an infrastructure layer by mode (identical to this.infrastructureLayers.get(mode))
boolean	InfrastructureLayersConfigurator.isModeMappedToLayer(Mode mode, String layerXmlId)	verify if mode is assigned to the layer
boolean	InfrastructureLayer.registerSupportedMode(Mode supportedMode)	register a mode as supported by this layer
boolean	InfrastructureLayerImpl.registerSupportedMode(Mode supportedMode)	register a mode as supported by this layer
String	InfrastructureLayersConfigurator.removeMode(Mode mode)	remove mode from any layer
String	InfrastructureLayersConfigurator.setModeToLayer(Mode mode, String layerXmlId)	set mode to a layer
default boolean	InfrastructureLayer.supports(Mode mode)	Determine if mode is supported by this layer

Method parameters in org.planit.network with type arguments of type Mode

Modifier and Type	Method	Description
boolean	InfrastructureLayer.registerSupportedModes(Collection<Mode> supportedModes)	register modes as supported by this layer
boolean	InfrastructureLayerImpl.registerSupportedModes(Collection<Mode> supportedModes)	register modes as supported by this layer

Uses of Mode in org.planit.network.converter

Methods in org.planit.network.converter that return types with arguments of type Mode

Modifier and Type	Method	Description
static Function<Mode,String>	IdMapperFunctionFactory.createModeIdMappingFunction(IdMapperType idMapper)	create a function that takes a mode and generates the appropriate id based on the user configuration

Uses of Mode in org.planit.network.macroscopic.physical

Fields in org.planit.network.macroscopic.physical with type parameters of type Mode

Modifier and Type	Field	Description
protected Map<Mode,MacroscopicModeProperties>	MacroscopicLinkSegmentTypeImpl.modeProperties	Map of mode properties for each mode for this link segment

Methods in org.planit.network.macroscopic.physical that return types with arguments of type Mode

Modifier and Type	Method	Description
Set<Mode>	MacroscopicLinkSegmentImpl.getAllowedModes()	Returns the modes that are allowed on the link segment
Set<Mode>	MacroscopicLinkSegmentTypeImpl.getAvailableModes()	return the available modes for which mode properties have been registered

Methods in org.planit.network.macroscopic.physical with parameters of type Mode

Modifier and Type	Method	Description
MacroscopicModeProperties	MacroscopicLinkSegmentTypeImpl.addModeProperties(Mode mode, MacroscopicModeProperties properties)	Add mode properties for this link segment
double	MacroscopicLinkSegmentImpl.computeFreeFlowTravelTime(Mode mode)	Compute the free flow travel time by mode, i.e.
static void	MacroscopicModePropertiesFactory.createOnLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType, Mode modeToAdd, double maxSpeedKmH)	add mode properties for the passed in modes to the passed in link segment type where we cap the max and critical speed based on the minimum of the mode's maximum speed and the osmway type's maximum speed
double	MacroscopicLinkSegmentImpl.getModelledSpeedLimitKmH(Mode mode)	Collect the maximum speed limit for the mode by taking the minimum of: (i) physical speed limit, (ii) mode's maximum speed limit, (iii) link segment type's mode specific speed limit.
MacroscopicModeProperties	MacroscopicLinkSegmentTypeImpl.getModeProperties(Mode mode)	Returns the mode properties for a specified mode along this link
boolean	MacroscopicLinkSegmentImpl.isModeAllowed(Mode mode)	Returns whether vehicles of a specified mode are allowed through this link
boolean	MacroscopicLinkSegmentTypeImpl.isModeAvailable(Mode mode)	Verify if mode is available on type
MacroscopicModeProperties	MacroscopicLinkSegmentTypeImpl.removeModeProperties(Mode toBeRemovedMode)	remove the mode properties for the passed in mode (if present)

Method parameters in org.planit.network.macroscopic.physical with type arguments of type Mode

Modifier and Type	Method	Description
MacroscopicLinkSegmentType	MacroscopicLinkSegmentTypesImpl.createAndRegisterNew(String name, double capacityPcuPerHour, double maximumDensityPcuPerKm, Map<Mode,MacroscopicModeProperties> modeProperties)	Create and register new macroscopic link segment type on network.
MacroscopicLinkSegmentType	MacroscopicPhysicalNetworkBuilder.createLinkSegmentType(String name, double capacity, double maximumDensity, Map<Mode,MacroscopicModeProperties> modeProperties)	Create a fully functional macroscopic link segment type instance
MacroscopicLinkSegmentType	MacroscopicPhysicalNetworkBuilderImpl.createLinkSegmentType(String name, double capacity, double maximumDensity, Map<Mode,MacroscopicModeProperties> modeProperties)	Create a fully functional macroscopic link segment type instance
static void	MacroscopicModePropertiesFactory.createOnLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType, Collection<Mode> modesToAdd, double maxSpeedKmH)	add mode properties for the passed in modes to the passed in link segment type where we cap the max and critical speed based on the minimum of the mode's maximum speed and the osmway type's maximum speed
void	MacroscopicLinkSegmentTypeImpl.setModeProperties(Map<Mode,MacroscopicModeProperties> modeProperties)	Set the map of mode properties for this link

Constructor parameters in org.planit.network.macroscopic.physical with type arguments of type Mode

Constructor	Description
MacroscopicLinkSegmentTypeImpl(IdGroupingToken groupId, String name, double capacityPerLane, double maximumDensityPerLane, Map<Mode,MacroscopicModeProperties> modeProperties)

Uses of Mode in org.planit.output

Method parameters in org.planit.output with type arguments of type Mode

Modifier and Type	Method	Description
void	OutputManager.persistOutputData(TimePeriod timePeriod, Set<Mode> modes, boolean converged)	Persist the output data for all registered output types

Uses of Mode in org.planit.output.adapter

Methods in org.planit.output.adapter with parameters of type Mode

Modifier and Type	Method	Description
Long	LinkOutputTypeAdapter.getInfrastructureLayerIdForMode(Mode mode)	collect the infrastructure layer id this mode resides on
Long	LinkOutputTypeAdapterImpl.getInfrastructureLayerIdForMode(Mode mode)	collect the infrastructure layer id this mode resides on
Object	LinkOutputTypeAdapter.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment
Object	LinkOutputTypeAdapterImpl.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment The DENSITY case should never be called for TraditionalStaticAssignment.
Object	TraditionalStaticAssignmentLinkOutputTypeAdapter.getLinkOutputPropertyValue(OutputProperty outputProperty, LinkSegment linkSegment, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Return the value of a specified output property of a link segment
protected double	LinkOutputTypeAdapterImpl.getMaximumSpeed(LinkSegment linkSegment, Mode mode)	Returns the maximum speed through the current link segment
Object	ODOutputTypeAdapter.getODOutputPropertyValue(OutputProperty outputProperty, ODMatrixIterator odMatrixIterator, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Returns the specified output property values for the current cell in the OD Matrix Iterator
Object	ODOutputTypeAdapterImpl.getODOutputPropertyValue(OutputProperty outputProperty, ODMatrixIterator odMatrixIterator, Mode mode, TimePeriod timePeriod, double timeUnitMultiplier)	Returns the specified output property values for the current cell in the OD Matrix Iterator
ODPathMatrix	PathOutputTypeAdapter.getODPathMatrix(Mode mode)	Retrieve an OD path matrix object for a specified mode
ODPathMatrix	TraditionalStaticPathOutputTypeAdapter.getODPathMatrix(Mode mode)	Retrieve an OD path matrix object for a specified mode
ODSkimMatrix	ODOutputTypeAdapter.getODSkimMatrix(ODSkimSubOutputType odSkimOutputType, Mode mode)	Retrieve an OD skim matrix for a specified OD skim output type and mode
ODSkimMatrix	TraditionalStaticAssignmentODOutputTypeAdapter.getODSkimMatrix(ODSkimSubOutputType odSkimOutputType, Mode mode)	Retrieve an OD skim matrix for a specified OD skim output type and mode
protected Object	OutputTypeAdapterImpl.getOutputTypeIndependentPropertyValue(OutputProperty outputProperty, Mode mode, TimePeriod timePeriod)	Returns the value of properties which are common to all output type adapters
Object	PathOutputTypeAdapter.getPathOutputPropertyValue(OutputProperty outputProperty, ODPathIterator odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)	Returns the specified output property values for the current cell in the ODPathIterator
Object	PathOutputTypeAdapterImpl.getPathOutputPropertyValue(OutputProperty outputProperty, ODPathIterator odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)	Returns the specified output property values for the current cell in the ODPathIterator
boolean	LinkOutputTypeAdapter.isFlowPositive(LinkSegment linkSegment, Mode mode)	Returns true if there is a flow through the current specified link segment for the specified mode
boolean	TraditionalStaticAssignmentLinkOutputTypeAdapter.isFlowPositive(LinkSegment linkSegment, Mode mode)	Returns true if there is a flow through the current specified link segment for the specified mode

Uses of Mode in org.planit.output.formatter

Methods in org.planit.output.formatter with parameters of type Mode

Modifier and Type	Method	Description
MemoryOutputIterator	MemoryOutputFormatter.getIterator(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType)	Returns a MemoryOutputIterator for the contents of the specified MultiKeyPlanItData map
Object	MemoryOutputFormatter.getOutputDataValue(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType, OutputProperty outputProperty, Object[] keyValues)	Get a specified data value

Method parameters in org.planit.output.formatter with type arguments of type Mode

Modifier and Type	Method	Description
void	BaseOutputFormatter.persist(TimePeriod timePeriod, Set<Mode> modes, OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputAdapter outputAdapter)	Write data to output file
void	OutputFormatter.persist(TimePeriod timePeriod, Set<Mode> modes, OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputAdapter outputAdapter)	Persist the output data based on the passed in configuration and adapter (contained in the configuration)
protected abstract void	BaseOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected abstract void	BaseOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to Map in memory
protected PlanItException	CsvFileOutputFormatter.writeLinkResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the Link CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the CSV file
protected void	MemoryOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the Map in memory
protected PlanItException	CsvFileOutputFormatter.writeOdResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the OD CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write OD Path results for the time period to the CSV file
protected void	MemoryOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Path results for the time period to the CSV file
protected PlanItException	CsvFileOutputFormatter.writePathResultsForCurrentTimePeriodToCsvPrinter(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, org.apache.commons.csv.CSVPrinter csvPrinter)	Write output values to the Path CSV file for the current iteration
protected abstract void	BaseOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file
protected void	MemoryOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file

Uses of Mode in org.planit.output.property

Methods in org.planit.output.property with parameters of type Mode

Modifier and Type	Method	Description
static Object	ModeExternalIdOutputProperty.getModeExternalId(Mode mode)	Returns the external Id of the current mode
static long	ModeIdOutputProperty.getModeId(Mode mode)	Returns the Id of the current mode
static String	ModeXmlIdOutputProperty.getModeXmlId(Mode mode)	Returns the Xml Id of the current mode

Uses of Mode in org.planit.tntp.output.formatter

Method parameters in org.planit.tntp.output.formatter with type arguments of type Mode

Modifier and Type	Method	Description
protected void	CSVOutputFormatter.writeGeneralResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write General results for the current time period to the CSV file
protected void	CSVOutputFormatter.writeLinkResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write link results for the current time period to the CSV file
protected void	CSVOutputFormatter.writeOdResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Origin-Destination results for the time period to the CSV file
protected void	CSVOutputFormatter.writePathResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Path results for the time period to the CSV file
protected void	CSVOutputFormatter.writeSimulationResultsForCurrentTimePeriod(OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputTypeEnum currentOutputType, OutputAdapter outputAdapter, Set<Mode> modes, TimePeriod timePeriod, int iterationIndex)	Write Simulation results for the current time period to the CSV file

Uses of Mode in org.planit.userclass

Methods in org.planit.userclass that return Mode

Modifier and Type	Method	Description
Mode	UserClass.getMode()	Return the mode of travel of this user class

Constructors in org.planit.userclass with parameters of type Mode

Constructor	Description
UserClass(IdGroupingToken groupId, String name, Mode mode, TravelerType travelerType)	Constructor of user class

Uses of Mode in org.planit.utils.mode

Subinterfaces of Mode in org.planit.utils.mode

Modifier and Type	Interface	Description
interface	PredefinedMode

Methods in org.planit.utils.mode that return Mode

Modifier and Type	Method	Description
Mode	Modes.get(long id)	Return a Mode by its id
Mode	Modes.getByXmlId(String xmlId)	Retrieve a Mode by its XML Id
Mode	Modes.getFirst()	Collect the first registered mode
Mode	Modes.registerNewCustomMode(String name, double maxSpeed, double pcu, PhysicalModeFeatures physicalFeatures, UsabilityModeFeatures usabilityFeatures)	Create and register new mode

Methods in org.planit.utils.mode that return types with arguments of type Mode

Modifier and Type	Method	Description
Set<Mode>	Modes.setOf()	Provide all modes as a set.

Methods in org.planit.utils.mode with parameters of type Mode

Modifier and Type	Method	Description
default boolean	Modes.contains(Mode mode)	Verify if mode is present

Uses of Mode in org.planit.utils.network.physical.macroscopic

Methods in org.planit.utils.network.physical.macroscopic that return types with arguments of type Mode

Modifier and Type	Method	Description
Set<Mode>	MacroscopicLinkSegment.getAllowedModes()	Returns the modes that are allowed on the link segment
Set<Mode>	MacroscopicLinkSegmentType.getAvailableModes()	return the available modes for which mode properties have been registered
default Set<Mode>	MacroscopicLinkSegmentType.getAvailableModesFrom(Collection<Mode> modes)	Method which identifies which of the passed in modes is unavailable on the link segment
default Set<Mode>	MacroscopicLinkSegmentType.getUnAvailableModesFrom(Collection<Mode> modes)	Method which identifies which of the passed in modes is unavailable on the link segment

Methods in org.planit.utils.network.physical.macroscopic with parameters of type Mode

Modifier and Type	Method	Description
MacroscopicModeProperties	MacroscopicLinkSegmentType.addModeProperties(Mode mode, MacroscopicModeProperties modeProperties)	Add mode properties for this link segment
double	MacroscopicLinkSegment.computeFreeFlowTravelTime(Mode mode)	Compute the free flow travel time by mode, i.e.
double	MacroscopicLinkSegment.getModelledSpeedLimitKmH(Mode mode)	Collect the maximum speed limit for the mode by taking the minimum of: (i) physical speed limit, (ii) mode's maximum speed limit, (iii) link segment type's mode specific speed limit.
MacroscopicModeProperties	MacroscopicLinkSegmentType.getModeProperties(Mode mode)	Returns the mode properties for a specified mode along this link
boolean	MacroscopicLinkSegment.isModeAllowed(Mode mode)	Returns whether vehicles of a specified mode are allowed through this link
boolean	MacroscopicLinkSegmentType.isModeAvailable(Mode mode)	Verify if mode is available on type
MacroscopicModeProperties	MacroscopicLinkSegmentType.removeModeProperties(Mode toBeRemovedMode)	remove the mode properties for the passed in mode (if present)

Method parameters in org.planit.utils.network.physical.macroscopic with type arguments of type Mode

Modifier and Type	Method	Description
MacroscopicLinkSegmentType	MacroscopicLinkSegmentTypes.createAndRegisterNew(String name, double capacityPcuPerHour, double maximumDensityPcuPerKm, Map<Mode,MacroscopicModeProperties> modeProperties)	Create and register new macroscopic link segment type on network.
default Set<Mode>	MacroscopicLinkSegmentType.getAvailableModesFrom(Collection<Mode> modes)	Method which identifies which of the passed in modes is unavailable on the link segment
default Set<Mode>	MacroscopicLinkSegmentType.getUnAvailableModesFrom(Collection<Mode> modes)	Method which identifies which of the passed in modes is unavailable on the link segment
default void	MacroscopicLinkSegmentType.removeModeProperties(Set<Mode> toBeRemovedModes)	remove the mode properties for the passed in modes
void	MacroscopicLinkSegmentType.setModeProperties(Map<Mode,MacroscopicModeProperties> modeProperties)	Set the map of mode properties for this link

Uses of Mode in org.planit.utils.zoning

Methods in org.planit.utils.zoning with parameters of type Mode

Modifier and Type	Method	Description
void	Connectoid.addAllowedMode(Zone zone, Mode... allowedModes)	add an allowed mode to the already
boolean	Connectoid.isModeAllowed(Zone accessZone, Mode mode)	Verify if a mode is allowed access to the zone via this connectoid

Uses of Mode in org.planit.zoning

Fields in org.planit.zoning with type parameters of type Mode

Modifier and Type	Field	Description
HashMap<Long,Mode>	ConnectoidImpl.AccessZoneProperties.allowedModes

Methods in org.planit.zoning with parameters of type Mode

Modifier and Type	Method	Description
void	ConnectoidImpl.addAllowedMode(Zone accessZone, Mode... allowedModes)	add an allowed mode to the already
boolean	ConnectoidImpl.isModeAllowed(Zone accessZone, Mode mode)	Verify if a mode is allowed access to the zone via this connectoid