Uses of Interface
org.goplanit.utils.mode.Mode
-
-
Uses of Mode in org.goplanit.assignment
Method parameters in org.goplanit.assignment with type arguments of type Mode Modifier and Type Method Description protected abstract voidStaticTrafficAssignment. executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)Execute the time period for the registered modes -
Uses of Mode in org.goplanit.assignment.algorithmb
Method parameters in org.goplanit.assignment.algorithmb with type arguments of type Mode Modifier and Type Method Description protected voidAlgorithmB. executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)Execute the time period for the registered modesvoidAlgorithmBEquilibration. executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)The method that performs the equilibration for a given time period using AlgorithmB -
Uses of Mode in org.goplanit.assignment.ltm.sltm
Methods in org.goplanit.assignment.ltm.sltm with parameters of type Mode Modifier and Type Method Description voidStaticLtmAssignmentStrategy. executeNetworkCostsUpdate(Mode theMode, boolean updateOnlyPotentiallyBlockingNodeCosts, double[] costsToUpdate)Perform an update of the network wide costs where a partial update is applied in case only potentially blocking nodes are updated during the loadingOptional<?>StaticLtmLinkOutputTypeAdapter. getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)Return the value of a specified output property of a link segment The DENSITY case should never be called for TraditionalStaticAssignment.double[]StaticLtmSimulationData. getLinkSegmentTravelTimePcuH(Mode theMode)Collect the travel time costs for a given mode supported by the loading of this dataOptional<Boolean>StaticLtmLinkOutputTypeAdapter. isFlowPositive(MacroscopicLinkSegment linkSegment, Mode mode)Returns true if there is a flow through the current specified link segment for the specified modeabstract booleanStaticLtmAssignmentStrategy. performIteration(Mode theMode, double[] costsToUpdate, int iterationIndex)Perform a single iteration where we perform a loading and then an equilibration step resulting in updated costsbooleanStaticLtmBushStrategy. performIteration(Mode theMode, double[] costsToUpdate, int iterationIndex)Perform an iteration by: 1.booleanStaticLtmPathStrategy. performIteration(Mode theMode, double[] costsToUpdate, int iterationIndex)Perform a single iteration where we perform a loading and then an equilibration step resulting in updated costsvoidStaticLtmSimulationData. setLinkSegmentTravelTimePcuH(Mode theMode, double[] travelTimeCostHour)Set the costs(travel time in hours per link segment) for a given mode supported by the loading of this datavoidStaticLtmAssignmentStrategy. updateTimePeriod(TimePeriod timePeriod, Mode mode, OdDemands odDemands)Invoked before start of equilibrating a new time periodConstructor parameters in org.goplanit.assignment.ltm.sltm with type arguments of type Mode Constructor Description StaticLtmSimulationData(TimePeriod timePeriod, Collection<Mode> supportedModes, long numberOfTotalLinkSegments)Constructor -
Uses of Mode in org.goplanit.assignment.ltm.sltm.loading
Methods in org.goplanit.assignment.ltm.sltm.loading that return Mode Modifier and Type Method Description ModeStaticLtmNetworkLoading. getSupportedMode()The supported modes of this loadingMethods in org.goplanit.assignment.ltm.sltm.loading with parameters of type Mode Modifier and Type Method Description voidStaticLtmNetworkLoading. initialiseInputs(Mode mode, OdDemands odDemands, TransportModelNetwork network)Initialise the loading with the given inputs -
Uses of Mode in org.goplanit.assignment.traditionalstatic
Methods in org.goplanit.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 modesMethods in org.goplanit.assignment.traditionalstatic with parameters of type Mode Modifier and Type Method Description Optional<?>TraditionalStaticAssignmentLinkOutputTypeAdapter. getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)Return the value of a specified output property of a link segmentdouble[]TraditionalStaticAssignmentSimulationData. getModalLinkSegmentCosts(Mode mode)Retrieve the link segment costs for a specified modeOdPathMatrixTraditionalStaticAssignmentSimulationData. getOdPathMatrix(Mode mode)Retrieve the current OD path for a specified modeOptional<OdPathMatrix>TraditionalStaticPathOutputTypeAdapter. getOdPathMatrix(Mode mode)Retrieve an OD path matrix object for a specified modeOptional<OdSkimMatrix>TraditionalStaticAssignmentOdOutputTypeAdapter. getOdSkimMatrix(OdSkimSubOutputType odSkimOutputType, Mode mode)Retrieve an OD skim matrix for a specified OD skim output type and modeOdSkimMatrixTraditionalStaticAssignmentSimulationData. getOdSkimMatrix(OdSkimSubOutputType odSkimOutputType, Mode mode)Retrieve the skim matrix for a specified mode and skim output typeMap<OdSkimSubOutputType,OdSkimMatrix>TraditionalStaticAssignmentSimulationData. getSkimMatrixMap(Mode mode)Retrieve the Map of OD Skim matrices for all active OD Skim Output Types for a specified modeOptional<Boolean>TraditionalStaticAssignmentLinkOutputTypeAdapter. isFlowPositive(MacroscopicLinkSegment linkSegment, Mode mode)Returns true if there is a flow through the current specified link segment for the specified modevoidTraditionalStaticAssignmentSimulationData. resetPathMatrix(Mode mode, OdZones zones)Reset the path matrix to empty for a specified mode for all activatedvoidTraditionalStaticAssignmentSimulationData. resetSkimMatrix(Mode mode, OdZones zones, OdOutputTypeConfiguration originDestinationOutputTypeConfiguration)Reset the skim matrix to all zeroes for a specified mode for all activated skim output typesvoidTraditionalStaticAssignmentSimulationData. setModalLinkSegmentCosts(Mode mode, double[] modalLinkSegmentCosts)Set the link segment costs for a specified modeMethod parameters in org.goplanit.assignment.traditionalstatic with type arguments of type Mode Modifier and Type Method Description protected voidTraditionalStaticAssignment. executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)Perform assignment for a given time period using Dijkstra's algorithm -
Uses of Mode in org.goplanit.converter
Methods in org.goplanit.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.goplanit.cost
Methods in org.goplanit.cost with parameters of type Mode Modifier and Type Method Description doubleCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, T edgeSegment)Get the first derivative of the used travel time computation method towards the edge segment (in) flow rate in PCU per hour, i.e.doubleCost. getGeneralisedCost(Mode mode, T edgeSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleCost. getTravelTimeCost(Mode mode, T edgeSegment)Returns the generalised cost of travel along an edge segment for a specified mode -
Uses of Mode in org.goplanit.cost.physical
Methods in org.goplanit.cost.physical with parameters of type Mode Modifier and Type Method Description protected doubleBPRLinkTravelTimeCost. 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 modedoubleBPRLinkTravelTimeCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, MacroscopicLinkSegment linkSegment)Get the first derivative of the used travel time computation method towards the edge segment (in) flow rate in PCU per hour, i.e.doubleFreeFlowLinkTravelTimeCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, MacroscopicLinkSegment linkSegment)Derivative of free flow travel time is zerodoubleSteadyStateTravelTimeCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, MacroscopicLinkSegment linkSegment)First Derivative towards inflowRate.doubleBPRLinkTravelTimeCost. getGeneralisedCost(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.doubleFreeFlowLinkTravelTimeCost. getGeneralisedCost(Mode mode, MacroscopicLinkSegment linkSegment)Return the free flow travel time for the current link for a given mode If the input data are invalid, this method returns a negative value.doubleSteadyStateTravelTimeCost. getGeneralisedCost(Mode mode, MacroscopicLinkSegment linkSegment)Return the average travel time for the current link segment for a given modedoubleBPRLinkTravelTimeCost. getTravelTimeCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleFreeFlowLinkTravelTimeCost. getTravelTimeCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleSteadyStateTravelTimeCost. getTravelTimeCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the generalised cost of travel along an edge segment for a specified modevoidAbstractPhysicalCost. populateWithCost(UntypedPhysicalLayer<?,?,?> physicalLayer, 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.voidBPRLinkTravelTimeCost. populateWithCost(UntypedPhysicalLayer<?,?,?> physicalLayer, Mode mode, double[] costToFill)populate the cost array with the BPR link travel times for all link segments for the specified modevoidSteadyStateTravelTimeCost. populateWithCost(UntypedPhysicalLayer<?,?,?> physicalLayer, Mode mode, double[] costToFill)Populate the cost array with the free flow link travel times for all link segments for the specified modevoidBPRConfigurator. setDefaultParameters(Mode mode, double alpha, double beta)Set the default alpha and beta values for a modevoidBPRConfigurator. setDefaultParameters(MacroscopicLinkSegmentType macroscopicLinkSegmentType, Mode mode, double alpha, double beta)Set the default alpha and beta values for a given link type and modevoidBPRLinkTravelTimeCost. setDefaultParameters(Mode mode, double alpha, double beta)Set the default alpha and beta values for a modevoidBPRLinkTravelTimeCost. setDefaultParameters(MacroscopicLinkSegmentType macroscopicLinkSegmentType, Mode mode, double alpha, double beta)Set the default alpha and beta values for a given link type and modevoidBPRConfigurator. setParameters(MacroscopicLinkSegment linkSegment, Mode mode, double alpha, double beta)Set the alpha and beta values for a given link segment and modevoidBPRLinkTravelTimeCost. 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.goplanit.cost.physical.initial
Fields in org.goplanit.cost.physical.initial with type parameters of type Mode Modifier and Type Field Description protected Map<Mode,Map<Long,Double>>InitialModesLinkSegmentCost. costPerModeAndLinkSegmentMap to store initial cost for each mode and link segment, not linked to a particular time periodMethods in org.goplanit.cost.physical.initial with parameters of type Mode Modifier and Type Method Description doubleInitialLinkSegmentCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, MacroscopicLinkSegment linkSegment)Not supported returns -infinity for all calls and logs severe warningdoubleInitialModesLinkSegmentCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, MacroscopicLinkSegment linkSegment)Not supported returns -infinity for all calls and logs severe warningdoubleInitialLinkSegmentCost. getGeneralisedCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the initial cost for each link segment and mode for time period agnostic registrations.doubleInitialModesLinkSegmentCost. getGeneralisedCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the initial cost for each link segment and mode.abstract doubleInitialPhysicalCost. getGeneralisedCost(Mode mode, MacroscopicLinkSegment linkSegment)get the initial cost for a specified mode and link segmentprotected doubleInitialLinkSegmentCost. getSegmentCost(InitialModesLinkSegmentCost initialCostsByMode, Mode mode, MacroscopicLinkSegment linkSegment)Returns the initial cost.doubleInitialLinkSegmentCost. getSegmentCost(TimePeriod timePeriod, Mode mode, MacroscopicLinkSegment linkSegment)Returns the initial cost for each link segment and mode for time period specific registrations.abstract doubleInitialPhysicalCost. getSegmentCost(TimePeriod timePeriod, Mode mode, MacroscopicLinkSegment linkSegment)get the initial cost for a specified mode and link segmentdoubleInitialLinkSegmentCost. getTravelTimeCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleInitialModesLinkSegmentCost. getTravelTimeCost(Mode mode, MacroscopicLinkSegment linkSegment)Returns the generalised cost of travel along an edge segment for a specified modebooleanInitialLinkSegmentCost. isSegmentCostsSetForMode(Mode mode)Are link segment costs available for the given mode (without time period)booleanInitialLinkSegmentCost. isSegmentCostsSetForMode(TimePeriod timePeriod, Mode mode)Are link segment costs available for the given mode (without time period)booleanInitialModesLinkSegmentCost. isSegmentCostsSetForMode(Mode mode)Are link segment costs available for the given modeabstract booleanInitialPhysicalCost. isSegmentCostsSetForMode(Mode mode)Are link segment costs available for the given mode (without time period)abstract booleanInitialPhysicalCost. isSegmentCostsSetForMode(TimePeriod timePeriod, Mode mode)Are link segment costs available for the given mode (without time period)voidManualInitialLinkSegmentCost. setAllSegmentCosts(Mode mode, double cost, int noLinkSegments)Sets a given cost for all link segments for a given modevoidInitialLinkSegmentCost. setSegmentCost(Mode mode, long linkSegmentId, double cost)same asInitialLinkSegmentCost.setSegmentCost(Mode, MacroscopicLinkSegment, double)only based on link segment's idvoidInitialLinkSegmentCost. setSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment, double cost)Set the initial cost for a specified mode and link segmentvoidInitialLinkSegmentCost. setSegmentCost(TimePeriod timePeriod, Mode mode, MacroscopicLinkSegment linkSegment, double cost)Set the initial cost for a specified mode and link segmentvoidInitialModesLinkSegmentCost. setSegmentCost(Mode mode, long linkSegmentId, double cost)Sets the initial cost for each link segment and modevoidInitialModesLinkSegmentCost. setSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment, double cost)Sets the initial cost for each link segment and modeabstract voidInitialPhysicalCost. setSegmentCost(Mode mode, MacroscopicLinkSegment linkSegment, double cost)Set the initial cost for a specified mode and link segmentabstract voidInitialPhysicalCost. setSegmentCost(TimePeriod timePeriod, Mode mode, MacroscopicLinkSegment linkSegment, double cost)Set the initial cost for a specified mode and link segment -
Uses of Mode in org.goplanit.cost.virtual
Methods in org.goplanit.cost.virtual with parameters of type Mode Modifier and Type Method Description doubleFixedConnectoidTravelTimeCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, ConnectoidSegment connectoidSegment)fixed cost so derivative is always zerodoubleSpeedConnectoidTravelTimeCost. getDTravelTimeDFlow(boolean uncongested, Mode mode, ConnectoidSegment connectoidSegment)Fixed, so derivative is always zerodoubleFixedConnectoidTravelTimeCost. getGeneralisedCost(Mode mode, ConnectoidSegment connectoidSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleSpeedConnectoidTravelTimeCost. getGeneralisedCost(Mode mode, ConnectoidSegment connectoidSegment)Return the connectoid travel time using speeddoubleFixedConnectoidTravelTimeCost. getTravelTimeCost(Mode mode, ConnectoidSegment connectoidSegment)Returns the generalised cost of travel along an edge segment for a specified modedoubleSpeedConnectoidTravelTimeCost. getTravelTimeCost(Mode mode, ConnectoidSegment connectoidSegment)Returns the generalised cost of travel along an edge segment for a specified modevoidFixedConnectoidTravelTimeCost. populateWithCost(VirtualNetwork virtualNetwork, 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 idvoidSpeedConnectoidTravelTimeCost. populateWithCost(VirtualNetwork virtualNetwork, 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 idvoidVirtualCost. populateWithCost(VirtualNetwork virtualNetwork, 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.goplanit.demands
Fields in org.goplanit.demands with type parameters of type Mode Modifier and Type Field Description protected TreeMap<Long,TreeMap<Mode,OdDemands>>Demands. odDemandsByTimePeriodAndModeTrip demand matricesMethods in org.goplanit.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 periodMethods in org.goplanit.demands with parameters of type Mode Modifier and Type Method Description UserClassDemands.UserClasses. createAndRegisterNewUserClass(String name, Mode mode, TravelerType travellerType)Factory method to create and register a new user class on the demandsOdDemandsDemands. get(Mode mode, TimePeriod timePeriod)Get an OdDemand by mode and time period in pcu/hourOdDemandsDemands. registerOdDemandPcuHour(TimePeriod timePeriod, Mode mode, OdDemands odDemandsPcuHour)Register provided odDemand -
Uses of Mode in org.goplanit.io.converter
Methods in org.goplanit.io.converter that return types with arguments of type Mode Modifier and Type Method Description protected Function<Mode,String>PlanitWriterImpl. getModeIdMapper()get id mapper for modes -
Uses of Mode in org.goplanit.io.converter.network
Method parameters in org.goplanit.io.converter.network with type arguments of type Mode Modifier and Type Method Description voidPlanitNetworkReader. parseLinkSegmentTypeAccessProperties(org.goplanit.xml.generated.XMLElementAccessGroup xmlAccessGroupProperties, MacroscopicLinkSegmentType linkSegmentType, Collection<Mode> defaultModes)parse the mode properties for given link segment type and populate the helper with them -
Uses of Mode in org.goplanit.io.output.formatter
Method parameters in org.goplanit.io.output.formatter with type arguments of type Mode Modifier and Type Method Description protected voidPlanItOutputFormatter. 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 fileprotected voidPlanItOutputFormatter. 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 fileprotected voidPlanItOutputFormatter. 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 fileprotected voidPlanItOutputFormatter. 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 fileprotected voidPlanItOutputFormatter. 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.goplanit.matsim.converter
Methods in org.goplanit.matsim.converter that return types with arguments of type Mode Modifier and Type Method Description Map<Mode,String>MatsimNetworkWriterSettings. createPlanitModeToMatsimModeMapping(MacroscopicNetworkLayerImpl networkLayer)Creating a mapping from actual PLANit modes in the network to the MATSIM mode mapping as per the configuration in this class instance -
Uses of Mode in org.goplanit.mode
Classes in org.goplanit.mode that implement Mode Modifier and Type Class Description classBicycleModethe predefined bicycle mode name: bicycle maxspeed (km/h): 15 pcu: 0.2 vehicular type: VEHICULAR motorisation: NON_MOTORISED track: ROAD use: PRIVATEclassBusModethe predefined bus mode name: bus maxspeed (km/h): 100 pcu: 2 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: PUBLICclassCarHighOccupancyModethe predefined car hov mode name: car_hov maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: HIGH_OCCUPANCYclassCarModethe predefined car mode name: car maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: PRIVATEclassCarShareModethe predefined car share mode name: car maxspeed (km/h): 130 pcu: 1 vehicular type: VEHICULAR motorisation: MOTORISED track: ROAD use: RIDE_SHAREclassGoodsModethe 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: GOODSclassHeavyGoodsModethe 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: GOODSclassLargeHeavyGoodsModethe 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: GOODSclassLightRailModethe predefined lightrail mode name: lightrail maxspeed (km/h): 70 pcu: 6 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLICclassModeImplA Mode is a user class feature representing a single form of transport (car, truck etc.).classMotorBikeModethe predefined motor bike mode name: bicycle maxspeed (km/h): 130 pcu: 0.5 vehicular type: VEHICULAR motorisation: NON_MOTORISED track: ROAD use: PRIVATEclassPedestrianModethe predefined pedestrian mode name: pedestrian maxspeed (km/h): 5 pcu: 0.1 vehicular type: NO_VEHICLE motorisation: NON_MOTORISED track: ROAD use: PRIVATEclassPredefinedModeImplA mode that has predefined fixed values so it can easily be understood, or mappedclassSubwayModethe predefined subway mode name: subway maxspeed (km/h): 60 pcu: 6 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLICclassTrainModethe predefined train mode name: train maxspeed (km/h): 140 pcu: 10 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLICclassTramModethe predefined tram mode name: tram maxspeed (km/h): 40 pcu: 3 vehicular type: VEHICULAR motorisation: MOTORISED track: RAIL use: PUBLICMethods in org.goplanit.mode that return Mode Modifier and Type Method Description ModeModesImpl. getByXmlId(String xmlId)Retrieve a Mode by its XML IdModeModeFactoryImpl. registerNewCustomMode(String name, double maxSpeed, double pcu, PhysicalModeFeatures physicalFeatures, UsabilityModeFeatures usabilityFeatures)Create and register new mode -
Uses of Mode in org.goplanit.network
Fields in org.goplanit.network with type parameters of type Mode Modifier and Type Field Description protected Map<Mode,String>MacroscopicNetworkLayerConfigurator. modeToLayerXmlIdtrack mode to layer mappingMethods in org.goplanit.network with parameters of type Mode Modifier and Type Method Description UTransportLayerNetwork. getLayerByMode(Mode mode)collect a layer by modebooleanMacroscopicNetworkLayerConfigurator. isModeMappedToLayer(Mode mode, String layerXmlId)verify if mode is assigned to the layerStringMacroscopicNetworkLayerConfigurator. removeMode(Mode mode)remove mode from any layerStringMacroscopicNetworkLayerConfigurator. setModeToLayer(Mode mode, String layerXmlId)set mode to a layer -
Uses of Mode in org.goplanit.network.layer
Fields in org.goplanit.network.layer with type parameters of type Mode Modifier and Type Field Description protected Map<Long,Mode>TransportLayerImpl. supportedModesthe modes supported by this layerMethods in org.goplanit.network.layer that return types with arguments of type Mode Modifier and Type Method Description Collection<Mode>ServiceNetworkLayerImpl. getSupportedModes()Collect supported modes, obtained from parent layerCollection<Mode>TransportLayerImpl. getSupportedModes()collect the modes supported by this infrastructure layerMethods in org.goplanit.network.layer with parameters of type Mode Modifier and Type Method Description MacroscopicNetworkLayerMacroscopicNetworkLayerFactoryImpl. registerNew(Mode... supportedModes)Create a new macroscopic network layer instancebooleanServiceNetworkLayerImpl. registerSupportedMode(Mode supportedMode)A service network does not allow for registering supported modes as the supported modes are defined by its parent network already.booleanTransportLayerImpl. registerSupportedMode(Mode supportedMode)register a mode as supported by this layerbooleanServiceNetworkLayerImpl. supports(Mode mode)Result delegate from underlying parent layerMethod parameters in org.goplanit.network.layer with type arguments of type Mode Modifier and Type Method Description booleanServiceNetworkLayerImpl. registerSupportedModes(Collection<Mode> supportedModes)A service network does not allow for registering supported modes as the supported modes are defined by its parent network already.booleanTransportLayerImpl. registerSupportedModes(Collection<Mode> supportedModes)register modes as supported by this layer -
Uses of Mode in org.goplanit.network.layer.macroscopic
Fields in org.goplanit.network.layer.macroscopic with type parameters of type Mode Modifier and Type Field Description protected Map<Mode,AccessGroupProperties>MacroscopicLinkSegmentTypeImpl. modeAccessPropertiesTrack access properties for each of the modes it supports for quick lookupsprotected Set<Mode>AccessGroupPropertiesImpl. supportedModesmodes supported by this access groupMethods in org.goplanit.network.layer.macroscopic that return types with arguments of type Mode Modifier and Type Method Description Set<Mode>AccessGroupPropertiesImpl. getAccessModes()The access modes for this groupSet<Mode>MacroscopicLinkSegmentImpl. getAllowedModes()Returns the modes that are allowed on the link segmentSet<Mode>MacroscopicLinkSegmentTypeImpl. getAllowedModes()return the available modes present in one of the access groups that have been registeredMethods in org.goplanit.network.layer.macroscopic with parameters of type Mode Modifier and Type Method Description voidAccessGroupPropertiesImpl. addAccessMode(Mode mode)Add mode to access group.doubleMacroscopicLinkSegmentImpl. computeFreeFlowTravelTimeHour(Mode mode)Compute the free flow travel time by mode, i.e.static AccessGroupPropertiesAccessGroupPropertiesFactory. create(double maxSpeedKmH, double criticalSpeedKmH, Mode... accessModes)Factory methodstatic AccessGroupPropertiesAccessGroupPropertiesFactory. create(double maxSpeedKmH, Mode... accessModes)Factory method adopting default value for critical speedstatic AccessGroupPropertiesAccessGroupPropertiesFactory. create(Mode... accessModes)Factory method allowing access for given modes without any further specification on their speedsstatic voidAccessGroupPropertiesFactory. createOnLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType, Mode modeToAdd, double maxSpeedKmH)Add access 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 maximum speedAccessGroupPropertiesMacroscopicLinkSegmentTypeImpl. getAccessProperties(Mode mode)Returns the mode properties for a specified mode along this linkbooleanMacroscopicLinkSegmentImpl. isModeAllowed(Mode mode)Returns whether vehicles of a specified mode are allowed through this linkbooleanMacroscopicLinkSegmentTypeImpl. isModeAllowed(Mode mode)Verify if mode is available on typeMacroscopicLinkSegmentTypeMacroscopicLinkSegmentTypeFactoryImpl. registerNew(String name, double capacityPcuPerHour, double maximumDensityPcuPerKm, Mode allowedMode)Create and register new macroscopic link segment type on network.booleanAccessGroupPropertiesImpl. removeAccessMode(Mode toBeRemovedMode)Remove access modebooleanMacroscopicLinkSegmentTypeImpl. removeModeAccess(Mode toBeRemovedMode)Remove the mode properties for the passed in mode (if present)Method parameters in org.goplanit.network.layer.macroscopic with type arguments of type Mode Modifier and Type Method Description static AccessGroupPropertiesAccessGroupPropertiesFactory. create(double maxSpeedKmH, double criticalSpeedKmH, Collection<Mode> accessModes)Factory methodstatic AccessGroupPropertiesAccessGroupPropertiesFactory. create(double maxSpeedKmH, Collection<Mode> accessModes)Factory method adopting saem value for maximum and critical speedstatic AccessGroupPropertiesAccessGroupPropertiesFactory. create(Collection<Mode> accessModes)Factory method allowing access for given modes without any further specification on their speedsstatic voidAccessGroupPropertiesFactory. createOnLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType, double maxSpeedKmH, Collection<Mode> modesToAdd)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 maximum speedConstructor parameters in org.goplanit.network.layer.macroscopic with type arguments of type Mode Constructor Description AccessGroupPropertiesImpl(Collection<Mode> accessModes)access properties with only defining allowed modes without setting any restrictive speeds compared to the physical speed on the links it is applied on -
Uses of Mode in org.goplanit.network.layers
Methods in org.goplanit.network.layers with parameters of type Mode Modifier and Type Method Description TTransportLayersImpl. get(Mode mode)Find the layer that supports the passed in mode. -
Uses of Mode in org.goplanit.osm.converter.network
Methods in org.goplanit.osm.converter.network that return Mode Modifier and Type Method Description ModeOsmNetworkReaderSettings. getMappedPlanitMode(String osmMode)convenience method that collects the currently mapped PLANit mode (road or rail) for the given OSM modeprotected ModeOsmWaySettings. getMappedPlanitMode(String osmMode)convenience method that collects the currently mapped PLANit mode for the given OSM modeModeOsmRailwaySettings. getMappedPlanitRailMode(String osmMode)convenience method that collects the currently mapped PLANit mode for the given OSM modeModeOsmHighwaySettings. getMappedPlanitRoadMode(String osmMode)convenience method that collects the currently mapped PLANit road mode for the given OSM modeMethods in org.goplanit.osm.converter.network that return types with arguments of type Mode Modifier and Type Method Description Set<Mode>OsmNetworkLayerModeParser. getExplicitlyExcludedModes(Map<String,String> tags, boolean isForwardDirection, OsmNetworkReaderSettings settings)Collect explicitly excluded modes from the passed in tags.Set<Mode>OsmNetworkLayerModeParser. getExplicitlyIncludedModes(Map<String,String> tags, boolean isForwardDirection, OsmNetworkReaderSettings settings)Collect explicitly included modes from the passed in tags.Set<Mode>OsmNetworkReaderSettings. getMappedPlanitModes(Collection<String> osmModes)convenience method that collects the currently mapped PLANit modes (road or rail) for the given OSM modesMethods in org.goplanit.osm.converter.network with parameters of type Mode Modifier and Type Method Description protected voidOsmWaySettings. addOsmMode2PlanitModeMapping(String osmMode, Mode planitMode)add mapping from osm mode to PLANit modeCollection<String>OsmNetworkReaderSettings. getMappedOsmModes(Mode planitMode)Collect the mapped OSM modes based on the provided PLANit modeprotected Collection<String>OsmWaySettings. getMappedOsmModes(Mode planitMode)convenience method that collects the currently mapped Osm modes for the given planit modeCollection<String>OsmRailwaySettings. getMappedOsmRailModes(Mode planitMode)convenience method that collects the currently mapped osm rail modes for the given planit modeCollection<String>OsmHighwaySettings. getMappedOsmRoadModes(Mode planitMode)convenience method that collects the currently mapped osm road modes for the given planit modeprotected voidOsmWaySettings. setOsmMode2PlanitModeMapping(String osmMode, Mode planitMode)Add/overwrite a mapping from OSM mode to PLANit mode.voidOsmRailwaySettings. setOsmRailMode2PlanitModeMapping(String osmRailMode, Mode planitMode)add/overwrite a mapping from OSM rail mode to PLANit mode.voidOsmHighwaySettings. setOsmRoadMode2PlanitModeMapping(String osmRoadMode, Mode planitMode)add/overwrite a mapping from OSM road mode to PLANit mode.Method parameters in org.goplanit.osm.converter.network with type arguments of type Mode Modifier and Type Method Description Set<String>OsmNetworkReaderSettings. getMappedOsmModes(Collection<Mode> planitModes)Collect the mapped OSM modes based on the provided PLANit modes (if any)voidOsmNetworkLayerModeParser. updateAccessKeyBasedModeRestrictions(Map<String,String> tags, Set<Mode> includedModesToUpdate, Set<Mode> excludedModesToUpdate)Update the included and excluded mode sets passed in based on the key/value information available in the access=? tag. -
Uses of Mode in org.goplanit.osm.converter.zoning.handler.helper
Methods in org.goplanit.osm.converter.zoning.handler.helper that return types with arguments of type Mode Modifier and Type Method Description Pair<Collection<String>,Collection<Mode>>OsmPublicTransportModeHelper. collectModesFromPtEntity(long osmPtEntityId, Map<String,String> tags, String defaultMode)collect the eligible modes both OSM and mapped PLANit modes for the given OSM entity representing pt infrastructure.Pair<Collection<String>,Collection<Mode>>OsmPublicTransportModeHelper. collectPublicTransportModesFromPtEntity(long osmPtEntityId, Map<String,String> tags, String defaultMode)collect the pt modes both OSM and mapped PLANit modes for a pt entity.Methods in org.goplanit.osm.converter.zoning.handler.helper with parameters of type Mode Modifier and Type Method Description Collection<DirectedConnectoid>ConnectoidHelper. createAndRegisterDirectedConnectoidsOnTopOfTransferZone(TransferZone transferZone, MacroscopicNetworkLayer networkLayer, Mode planitMode, PlanitJtsCrsUtils geoUtils)Create directed connectoids for transfer zones that reside on osw ways.booleanConnectoidHelper. extractDirectedConnectoidsForMode(de.topobyte.osm4j.core.model.iface.OsmNode osmNode, TransferZone transferZone, Mode planitMode, PlanitJtsCrsUtils geoUtils)create and/or update directed connectoids for the given mode and layer based on the passed in osm node (location) where the connectoids access link segments are extracted for.booleanConnectoidHelper. extractDirectedConnectoidsForMode(org.locationtech.jts.geom.Point location, TransferZone transferZone, Mode planitMode, Collection<Link> eligibleAccessLinks, PlanitJtsCrsUtils geoUtils)create and/or update directed connectoids for the given mode and layer based on the passed in location where the connectoids access link segments are extracted for.voidConnectoidHelper. extractDirectedConnectoidsForStandAloneTransferZoneByPlanitLink(long osmWaitingAreaId, org.locationtech.jts.geom.Geometry waitingAreaGeometry, Link accessLink, TransferZone transferZone, Mode accessMode, double maxAllowedStopToTransferZoneDistanceMeters, MacroscopicNetworkLayer networkLayer)create connectoids not based on osm node location but based on auto-generated geographic location on the provided link's link segments by finding either a close enough existing coordinate (osm node), or if not close enough a newly created coordinate at the appropriate position.org.locationtech.jts.geom.PointConnectoidHelper. findConnectoidLocationForstandAloneTransferZoneOnLink(TransferZone transferZone, Link accessLink, Mode accessMode, double maxAllowedStopToTransferZoneDistanceMeters, MacroscopicNetworkLayer networkLayer)find a suitable connectoid location on the given link based on the constraints that it must be able to reside on a linksegment that is in the correct relative position to the transfer zone and supports the access mode on at least one of the designated link segment(s) that is eligible (if any). -
Uses of Mode in org.goplanit.osm.physical.network.macroscopic
Fields in org.goplanit.osm.physical.network.macroscopic with type parameters of type Mode Modifier and Type Field Description protected Map<Set<Mode>,Set<MacroscopicLinkSegmentType>>ModifiedLinkSegmentTypes.ModifiedLinkSegmentTypesModes. linkSegmentTypesWithAddedModesthe segment types with added modes compared to the originalprotected Map<Set<Mode>,Set<MacroscopicLinkSegmentType>>ModifiedLinkSegmentTypes.ModifiedLinkSegmentTypesModes. linkSegmentTypesWithRemovedModesthe segment types with removed modes compared to the originalMethods in org.goplanit.osm.physical.network.macroscopic that return types with arguments of type Mode Modifier and Type Method Description protected Collection<Mode>PlanitOsmNetwork. collectMappedPlanitModes(String osmWayKey, String osmWayValue, OsmNetworkReaderSettings settings)collect the PLANit mode that are mapped, i.e., are marked to be activated in the final network.Method parameters in org.goplanit.osm.physical.network.macroscopic with type arguments of type Mode Modifier and Type Method Description booleanModifiedLinkSegmentTypes. addModifiedLinkSegmentType(MacroscopicLinkSegmentType original, MacroscopicLinkSegmentType modifiedLinkSegmentType, Set<Mode> addedModes, Set<Mode> removedModes)Add a modified link segment type based on the changes in mode support.booleanModifiedLinkSegmentTypes.ModifiedLinkSegmentTypesModes. addModifiedLinkSegmentType(MacroscopicLinkSegmentType modifiedLinkSegmentType, Set<Mode> addedModes, Set<Mode> removedModes)Add a modified link segment type based on the changes in mode support.booleanModifiedLinkSegmentTypes. containsModifiedLinkSegmentType(MacroscopicLinkSegmentType original, Set<Mode> addedModes, Set<Mode> removedModes)Verify if a modified link segment type with the provided added/removed modes exist for the given original link segment typebooleanModifiedLinkSegmentTypes.ModifiedLinkSegmentTypesModes. containsModifiedLinkSegmentType(Set<Mode> addedModes, Set<Mode> removedModes)Verify if a modified link segment type with the provided added/removed modes existprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createBridleway(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create bridleway type with defaults For horse riders.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createCycleway(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create cycleway type with defaults For designated cyclewaysprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createDefaultOsmLinkSegmentType(String name, double capacityPcuPerhour, double maxSpeedKmh, Collection<Mode> modes)Create an OSM default link segment typeprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createFootway(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create footway type with defaults For designated footpaths; i.e., mainly/exclusively for pedestrians.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createFunicular(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create funicular (rail) type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createLightRail(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create light rail (rail) type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createLivingStreet(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create living street type with defaults Roads which serve as an access to housing, without function of connecting settlements.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createMonoRail(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create mono rail (rail) type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createMotorway(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create motorway type with defaults restricted access major divided highway, normally with 2 or more running lanes plus emergency hard shoulder.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createMotorwayLink(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create motorway link type with defaults The link roads (sliproads/ramps) leading to/from a motorway from/to a motorway or lower class highway.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createNarrowGauge(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create narrow gauge(rail) type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createOsmLinkSegmentType(String externalId, double capacityPcuPerhour, double maxDensityPcuPerKm, double maxSpeed, Collection<Mode> modes)Create OSM default link segment types with mode properties where we create multiple types if modes reside on different layers in which case only the modes on that layer will be added to the layer specific typeprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createOsmRailWayLinkSegmentType(String railwayTypeValue, double maxSpeed, Collection<Mode> modes)Create a link segment type on the network based on the passed in OSM railway value tagsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createOsmRoadWayLinkSegmentType(String highwayTypeValue, double maxSpeed, Collection<Mode> modes)Create a link segment type on the network based on the passed in OSM highway value tags.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createPath(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create path type with defaults A non-specific path either multi-use or unspecified usage, open to all non-motorized vehicles and not intended for motorized vehicles unless tagged so separatelyprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createPedestrian(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create pedestrian type with defaults For roads used mainly/exclusively for pedestrians in shopping and some residential areas which may allow access by motorised vehicles only for very limited periods of the day.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createPrimary(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create primary type with defaults The next most important roads in a country's system (after trunk).protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createPrimaryLink(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create primary link type with defaults The link roads (sliproads/ramps) leading to/from a primary road from/to a primary road or lower class highway.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createRail(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create rail type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createResidential(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create residential type with defaults Roads which serve as an access to housing, without function of connecting settlements.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createRoad(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create road type with defaults A road/way/street/motorway/etc.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createSecondary(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create secondary type with defaults The link roads (sliproads/ramps) leading to/from a primary road from/to a primary road or lower class highway.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createSecondaryLink(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create secondary link type with defaults The link roads (sliproads/ramps) leading to/from a secondary road from/to a secondary road or lower class highway.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createService(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create service type with defaults For access roads to, or within an industrial estate, camp site, business park, car park, alleys, etc.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createSteps(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create step type with defaults For flights of steps (stairs) on footwaysprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createSubway(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create subway type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTertiary(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create tertiary type with defaults The next most important roads in a country's system (after secondary).protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTertiaryLink(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create tertiary link type with defaults The link roads (sliproads/ramps) leading to/from a tertiary road from/to a tertiary road or lower class highway.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTrack(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create track type with defaults Roads for mostly agricultural or forestry uses.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTram(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create tram type with defaultsprotected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTrunk(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create trunk type with defaults The most important roads in a country's system that aren't motorways.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createTrunkLink(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create trunk link type with defaults restricted access major divided highway, normally with 2 or more running lanes plus emergency hard shoulder.protected Map<TransportLayer,MacroscopicLinkSegmentType>PlanitOsmNetwork. createUnclassified(double osmHighwayTypeMaxSpeed, Collection<Mode> modes)Create unclassified type with defaults The least important through roads in a country's system – i.e.MacroscopicLinkSegmentTypeModifiedLinkSegmentTypes. getModifiedLinkSegmentType(MacroscopicLinkSegmentType original, Set<Mode> addedModes, Set<Mode> removedModes)Collect a modified link segment type with the provided added/removed modes if it existsMacroscopicLinkSegmentTypeModifiedLinkSegmentTypes.ModifiedLinkSegmentTypesModes. getModifiedLinkSegmentType(Set<Mode> addedModes, Set<Mode> removedModes)collect a modified link segment type with the provided added/removed modes exist -
Uses of Mode in org.goplanit.osm.util
Methods in org.goplanit.osm.util with parameters of type Mode Modifier and Type Method Description static MacroscopicLinkSegmentPlanitLinkSegmentUtils. getLinkSegmentIfLinkIsOneWayForMode(Link link, Mode accessMode)Collect the one way link segment for the mode if the link is in fact one way.static Collection<EdgeSegment>PlanitTransferZoneUtils. identifyInvalidTransferZoneAccessLinkSegmentsBasedOnRelativeLocationToInfrastructure(Collection<EdgeSegment> accessLinkSegments, TransferZone transferZone, Mode planitMode, boolean leftHandDrive, PlanitJtsCrsUtils geoUtils)Find the access link segments ineligible given the intended location of the to be created connectoid, the transfer zone provided, and the access mode.Method parameters in org.goplanit.osm.util with type arguments of type Mode Modifier and Type Method Description static booleanOsmModeUtils. hasEligibleOsmMode(Pair<Collection<String>,Collection<Mode>> modeResult)Check to see if pair with eligible modes contains any eligible OSM modestatic booleanOsmModeUtils. hasMappedPlanitMode(Pair<Collection<String>,Collection<Mode>> modeResult)Check to see if pair with eligible modes contains any mapped PLANit mode -
Uses of Mode in org.goplanit.output
Method parameters in org.goplanit.output with type arguments of type Mode Modifier and Type Method Description booleanOutputManager. isAnyOutputPersisted(TimePeriod timePeriod, Set<Mode> modes, boolean converged)Verify if anything is actually persisted whenOutputManager.persistOutputData(TimePeriod, Set, boolean)is invoked given the underlying configurationvoidOutputManager. persistOutputData(TimePeriod timePeriod, Set<Mode> modes, boolean converged)Persist the output data for all registered output types -
Uses of Mode in org.goplanit.output.adapter
Methods in org.goplanit.output.adapter with parameters of type Mode Modifier and Type Method Description Optional<Long>MacroscopicLinkOutputTypeAdapter. getInfrastructureLayerIdForMode(Mode mode)collect the infrastructure layer id this mode resides onOptional<Long>MacroscopicLinkOutputTypeAdapterImpl. getInfrastructureLayerIdForMode(Mode mode)collect the infrastructure layer id this mode resides onOptional<?>MacroscopicLinkOutputTypeAdapter. getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)Return the value of a specified output property of a link segmentOptional<?>MacroscopicLinkOutputTypeAdapterImpl. getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, MacroscopicLinkSegment linkSegment, Mode mode, TimePeriod timePeriod)Return the value of a specified output property of a link segment The DENSITY case should never be called for TraditionalStaticAssignment.default Optional<Double>MacroscopicLinkOutputTypeAdapter. getMaximumSpeed(MacroscopicLinkSegment linkSegment, Mode mode)Returns the maximum speed through the current link segmentOptional<?>OdOutputTypeAdapter. getOdOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<?> odIterator, Mode mode, TimePeriod timePeriod)Returns the specified output property values for the current cell in the OD Matrix IteratorOptional<?>OdOutputTypeAdapterImpl. getOdOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<?> odIterator, Mode mode, TimePeriod timePeriod)Returns the specified output property values for the current cell in the OD Matrix IteratorOptional<OdPathMatrix>PathOutputTypeAdapter. getOdPathMatrix(Mode mode)Retrieve an OD path matrix object for a specified modeOptional<OdSkimMatrix>OdOutputTypeAdapter. getOdSkimMatrix(OdSkimSubOutputType odSkimOutputType, Mode mode)Retrieve an OD skim matrix for a specified OD skim output type and modeprotected Optional<?>OutputTypeAdapterImpl. getOutputTypeIndependentPropertyValue(OutputProperty outputProperty, Mode mode, TimePeriod timePeriod)Returns the value of properties which are common to all output type adaptersOptional<?>PathOutputTypeAdapter. getPathOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<? extends DirectedPath> odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)Returns the specified output property values for the current cell in the ODPathIteratorOptional<?>PathOutputTypeAdapterImpl. getPathOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<? extends DirectedPath> odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)Returns the specified output property values for the current cell in the ODPathIteratorOptional<Boolean>MacroscopicLinkOutputTypeAdapter. isFlowPositive(MacroscopicLinkSegment 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.goplanit.output.formatter
Methods in org.goplanit.output.formatter with parameters of type Mode Modifier and Type Method Description MemoryOutputIteratorMemoryOutputFormatter. getIterator(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType)Returns a MemoryOutputIterator for the contents of the specified MultiKeyPlanItData mapObjectMemoryOutputFormatter. getOutputDataValue(Mode mode, TimePeriod timePeriod, Integer iterationIndex, OutputType outputType, OutputPropertyType outputProperty, Object[] keyValues)Get a specified data valueMethod parameters in org.goplanit.output.formatter with type arguments of type Mode Modifier and Type Method Description voidBaseOutputFormatter. persist(TimePeriod timePeriod, Set<Mode> modes, OutputConfiguration outputConfiguration, OutputTypeConfiguration outputTypeConfiguration, OutputAdapter outputAdapter)Write data to output filevoidOutputFormatter. 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 voidBaseOutputFormatter. 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 fileprotected voidMemoryOutputFormatter. 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 fileprotected abstract voidBaseOutputFormatter. 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 fileprotected voidMemoryOutputFormatter. 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 memoryprotected PlanItExceptionCsvFileOutputFormatter. 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 iterationprotected abstract voidBaseOutputFormatter. 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 fileprotected voidMemoryOutputFormatter. 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 memoryprotected PlanItExceptionCsvFileOutputFormatter. 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 iterationprotected abstract voidBaseOutputFormatter. 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 fileprotected voidMemoryOutputFormatter. 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 fileprotected PlanItExceptionCsvFileOutputFormatter. 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 iterationprotected abstract voidBaseOutputFormatter. 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 fileprotected voidMemoryOutputFormatter. 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.goplanit.output.property
Methods in org.goplanit.output.property with parameters of type Mode Modifier and Type Method Description static Optional<String>ModeExternalIdOutputProperty. getModeExternalId(Mode mode)Returns the external Id of the current modestatic Optional<Long>ModeIdOutputProperty. getModeId(Mode mode)Returns the Id of the current modestatic Optional<String>ModeXmlIdOutputProperty. getModeXmlId(Mode mode)Returns the Xml Id of the current mode -
Uses of Mode in org.goplanit.service.routed
Methods in org.goplanit.service.routed that return Mode Modifier and Type Method Description ModeRoutedModeServices. getMode()The supported mode for the routed services registeredModeRoutedModeServicesImpl. getMode()The supported mode for the routed services registeredMethods in org.goplanit.service.routed with parameters of type Mode Modifier and Type Method Description RoutedModeServicesRoutedServicesLayer. getServicesByMode(Mode mode)The services for a given mode available on this layer.RoutedModeServicesRoutedServicesLayerImpl. getServicesByMode(Mode mode)The services for a given mode available on this layer.Constructors in org.goplanit.service.routed with parameters of type Mode Constructor Description RoutedModeServicesImpl(IdGroupingToken tokenId, Mode supportedMode)Constructor -
Uses of Mode in org.goplanit.tntp.output.formatter
Method parameters in org.goplanit.tntp.output.formatter with type arguments of type Mode Modifier and Type Method Description protected voidCSVOutputFormatter. 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 fileprotected voidCSVOutputFormatter. 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 fileprotected voidCSVOutputFormatter. 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 fileprotected voidCSVOutputFormatter. 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 fileprotected voidCSVOutputFormatter. 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.goplanit.userclass
Methods in org.goplanit.userclass that return Mode Modifier and Type Method Description ModeUserClass. getMode()Return the mode of travel of this user classConstructors in org.goplanit.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.goplanit.utils.mode
Subinterfaces of Mode in org.goplanit.utils.mode Modifier and Type Interface Description interfacePredefinedModeFields in org.goplanit.utils.mode with type parameters of type Mode Modifier and Type Field Description static Class<Mode>Mode. MODE_ID_CLASSid class for generating idsMethods in org.goplanit.utils.mode that return Mode Modifier and Type Method Description ModeModes. getByXmlId(String xmlId)Retrieve a Mode by its XML IdModeModeFactory. registerNewCustomMode(String name, double maxSpeed, double pcu, PhysicalModeFeatures physicalFeatures, UsabilityModeFeatures usabilityFeatures)Create and register new modeMethods in org.goplanit.utils.mode that return types with arguments of type Mode Modifier and Type Method Description default Class<Mode>Mode. getIdClass()Each managed id class is expected to generate its ids based on its class signature. -
Uses of Mode in org.goplanit.utils.network.layer
Methods in org.goplanit.utils.network.layer that return Mode Modifier and Type Method Description default ModeTransportLayer. getFirstSupportedMode()Collect the first mode found under the supported modes from the collection provided by getSupportedModesMethods in org.goplanit.utils.network.layer that return types with arguments of type Mode Modifier and Type Method Description Collection<Mode>TransportLayer. getSupportedModes()collect the modes supported by this infrastructure layerMethods in org.goplanit.utils.network.layer with parameters of type Mode Modifier and Type Method Description booleanTransportLayer. registerSupportedMode(Mode supportedMode)register a mode as supported by this layerdefault booleanTransportLayer. supports(Mode mode)Determine if mode is supported by this layerMethod parameters in org.goplanit.utils.network.layer with type arguments of type Mode Modifier and Type Method Description booleanTransportLayer. registerSupportedModes(Collection<Mode> supportedModes)register modes as supported by this layer -
Uses of Mode in org.goplanit.utils.network.layer.macroscopic
Methods in org.goplanit.utils.network.layer.macroscopic that return types with arguments of type Mode Modifier and Type Method Description Set<Mode>AccessGroupProperties. getAccessModes()The access modes for this groupSet<Mode>MacroscopicLinkSegment. getAllowedModes()Returns the modes that are allowed on the link segmentSet<Mode>MacroscopicLinkSegmentType. getAllowedModes()return the available modes present in one of the access groups that have been registereddefault Set<Mode>MacroscopicLinkSegment. getAllowedModesFrom(Collection<Mode> modes)collect the allowed modes from the passed in modesdefault Set<Mode>MacroscopicLinkSegmentType. getAllowedModesFrom(Collection<Mode> modes)Method which identifies which of the passed in modes is available on the link segmentdefault Set<Mode>MacroscopicLinkSegmentType. getAllowedModesNotIn(Collection<Mode> modes)Method which identifies which of the passed in modes is available on the link segment but not in the passed in collection of modesdefault Set<Mode>MacroscopicLinkSegmentType. getDisallowedModesFrom(Collection<Mode> modes)Method which identifies which of the passed in modes is unavailable on the link segmentMethods in org.goplanit.utils.network.layer.macroscopic with parameters of type Mode Modifier and Type Method Description voidAccessGroupProperties. addAccessMode(Mode mode)Add a new access mode to the groupdoubleMacroscopicLinkSegment. computeFreeFlowTravelTimeHour(Mode mode)Compute the free flow travel time by mode, i.e.AccessGroupPropertiesMacroscopicLinkSegmentType. getAccessProperties(Mode mode)Returns the access properties for a specified mode along this linkdefault DoubleMacroscopicLinkSegmentType. getCriticalSpeedKmH(Mode mode)Collect the critical speed based on the combination of the mode and any restrictions imposed by the type on this mode.default double[]MacroscopicLinkSegments. getFreeFlowTravelTimeHourPerLinkSegment(Mode mode)Create a raw array of all free flow travel times of the registered macroscopic link segments where the index in the array corresponds to the link segment id (not id).default DoubleMacroscopicLinkSegmentType. getMaximumSpeedKmH(Mode mode)Collect the maximum speed based on the combination of the mode and any restrictions imposed by the type on this mode.default doubleMacroscopicLinkSegment. 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.booleanMacroscopicLinkSegment. isModeAllowed(Mode mode)Returns whether vehicles of a specified mode are allowed through this linkbooleanMacroscopicLinkSegmentType. isModeAllowed(Mode mode)Verify if mode is available on typeMacroscopicLinkSegmentTypeMacroscopicLinkSegmentTypeFactory. registerNew(String name, double capacityPcuPerHour, double maximumDensityPcuPerKm, Mode allowedMode)Create and register new macroscopic link segment type on network.booleanAccessGroupProperties. removeAccessMode(Mode toBeRemovedMode)Remove access modebooleanMacroscopicLinkSegmentType. removeModeAccess(Mode toBeRemovedMode)Remove the mode properties for the passed in mode (if present)Method parameters in org.goplanit.utils.network.layer.macroscopic with type arguments of type Mode Modifier and Type Method Description default Set<Mode>MacroscopicLinkSegment. getAllowedModesFrom(Collection<Mode> modes)collect the allowed modes from the passed in modesdefault Set<Mode>MacroscopicLinkSegmentType. getAllowedModesFrom(Collection<Mode> modes)Method which identifies which of the passed in modes is available on the link segmentdefault Set<Mode>MacroscopicLinkSegmentType. getAllowedModesNotIn(Collection<Mode> modes)Method which identifies which of the passed in modes is available on the link segment but not in the passed in collection of modesdefault Set<Mode>MacroscopicLinkSegmentType. getDisallowedModesFrom(Collection<Mode> modes)Method which identifies which of the passed in modes is unavailable on the link segmentdefault voidMacroscopicLinkSegmentType. removeModeAccess(Set<Mode> toBeRemovedModes)Remove mode access for the passed in modes -
Uses of Mode in org.goplanit.utils.network.layers
Methods in org.goplanit.utils.network.layers with parameters of type Mode Modifier and Type Method Description TTransportLayers. get(Mode mode)Find the layer that supports the passed in mode.MacroscopicNetworkLayerMacroscopicNetworkLayerFactory. registerNew(Mode... supportedModes)Create a new macroscopic network layer instance -
Uses of Mode in org.goplanit.utils.zoning
Methods in org.goplanit.utils.zoning that return types with arguments of type Mode Modifier and Type Method Description Collection<Mode>Connectoid. getExplicitlyAllowedModes(Zone accessZone)collect modes that are explicitly allowed for this zone (unmodifiable).Methods in org.goplanit.utils.zoning with parameters of type Mode Modifier and Type Method Description voidConnectoid. addAllowedMode(Zone zone, Mode allowedMode)Add an allowed mode.default voidConnectoid. addAllowedModes(Zone zone, Mode... allowedModes)Add allowed modes.booleanConnectoid. isModeAllowed(Zone accessZone, Mode mode)Verify if a mode is allowed access to the zone via this connectoidMethod parameters in org.goplanit.utils.zoning with type arguments of type Mode Modifier and Type Method Description default voidConnectoid. addAllowedModes(TransferZone transferZone, Set<Mode> allowedModes)Add allowed modes. -
Uses of Mode in org.goplanit.zoning
Fields in org.goplanit.zoning with type parameters of type Mode Modifier and Type Field Description TreeMap<Long,Mode>ConnectoidImpl.AccessZoneProperties. allowedModesthe explicitly allowed modes, when null all modes allowedMethods in org.goplanit.zoning that return types with arguments of type Mode Modifier and Type Method Description Collection<Mode>ConnectoidImpl. getExplicitlyAllowedModes(Zone accessZone)collect modes that are explicitly allowed for this zone (unmodifiable).Methods in org.goplanit.zoning with parameters of type Mode Modifier and Type Method Description voidConnectoidImpl. addAllowedMode(Zone accessZone, Mode allowedMode)Add an allowed mode.booleanConnectoidImpl. isModeAllowed(Zone accessZone, Mode mode)Verify if a mode is allowed access to the zone via this connectoid
-