Inheritance diagram for org.matsim.pt.routes.TransitPassengerRoute:

[legend]

Public Member Functions
Id< TransitStopFacility >	getAccessStopId ()

Id< TransitStopFacility >	getEgressStopId ()

Id< TransitLine >	getLineId ()

Id< TransitRoute >	getRouteId ()

OptionalTime	getBoardingTime ()

double	getDistance ()

void	setDistance (final double distance)

OptionalTime	getTravelTime ()

void	setTravelTime (final double travelTime)

void	setTravelTimeUndefined ()

Id< Link >	getStartLinkId ()

Id< Link >	getEndLinkId ()

void	setStartLinkId (final Id< Link > linkId)

void	setEndLinkId (final Id< Link > linkId)

String	getRouteDescription ()

void	setRouteDescription (final String routeDescription)

String	getRouteType ()

Route	clone ()

Detailed Description

Definition at line 30 of file TransitPassengerRoute.java.

Member Function Documentation

◆ getAccessStopId()

Id<TransitStopFacility> org.matsim.pt.routes.TransitPassengerRoute.getAccessStopId ( )

Implemented in org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.pt.routes.ExperimentalTransitRoute.

Referenced by org.matsim.core.population.routes.RouteUtils.calcDistance(), org.matsim.core.router.TransitRouterWrapper.fillWithActivities(), and org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getDesiredAccessStopId().

◆ getEgressStopId()

Id<TransitStopFacility> org.matsim.pt.routes.TransitPassengerRoute.getEgressStopId ( )

Implemented in org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.pt.routes.ExperimentalTransitRoute.

Referenced by org.matsim.core.population.routes.RouteUtils.calcDistance(), org.matsim.core.router.TransitRouterWrapper.fillWithActivities(), org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getDesiredDestinationStopId(), org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getEnterTransitRoute(), and org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getExitAtStop().

◆ getLineId()

Id<TransitLine> org.matsim.pt.routes.TransitPassengerRoute.getLineId ( )

Implemented in org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.pt.routes.ExperimentalTransitRoute.

Referenced by org.matsim.core.population.routes.RouteUtils.calcDistance(), and org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getEnterTransitRoute().

◆ getRouteId()

Id<TransitRoute> org.matsim.pt.routes.TransitPassengerRoute.getRouteId ( )

Implemented in org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.pt.routes.ExperimentalTransitRoute.

Referenced by org.matsim.core.population.routes.RouteUtils.calcDistance().

◆ getBoardingTime()

OptionalTime org.matsim.pt.routes.TransitPassengerRoute.getBoardingTime ( )

Implemented in org.matsim.pt.routes.ExperimentalTransitRoute, and org.matsim.pt.routes.DefaultTransitPassengerRoute.

◆ getDistance()

double org.matsim.api.core.v01.population.Route.getDistance ( )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.deprecated.scoring.functions.CharyparNagelLegScoring.calcLegScore(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getDistance(), org.matsim.analysis.TripsAndLegsWriter.getLegRecord(), org.matsim.analysis.TravelDistanceStats.getLegStats(), and org.matsim.utils.gis.matsim2esri.plans.SelectedPlans2ESRIShape.writeLegs().

◆ setDistance()

void org.matsim.api.core.v01.population.Route.setDistance ( final double distance )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute(), ch.sbb.matsim.routing.pt.raptor.DefaultRaptorStopFinder.addInitialStopsForParamSet(), ch.sbb.matsim.routing.pt.raptor.RaptorUtils.convertRouteToLegs(), org.matsim.core.router.TransitRouterWrapper.createWalkRoute(), org.matsim.core.router.TransitRouterWrapper.fillWithActivities(), org.matsim.core.scoring.EventsToLegs.handleEvent(), and org.matsim.core.router.TeleportationRoutingModule.toString().

◆ getTravelTime()

OptionalTime org.matsim.api.core.v01.population.Route.getTravelTime ( )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.core.utils.timing.TimeInterpretation.decideOnLegTravelTime(), and org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getTravelTime().

◆ setTravelTime()

void org.matsim.api.core.v01.population.Route.setTravelTime ( final double travelTime )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by ch.sbb.matsim.routing.pt.raptor.DefaultRaptorStopFinder.addInitialStopsForParamSet(), ch.sbb.matsim.routing.pt.raptor.RaptorUtils.convertRouteToLegs(), org.matsim.core.router.TransitRouterWrapper.createWalkRoute(), org.matsim.core.router.TransitRouterWrapper.fillWithActivities(), org.matsim.core.scoring.EventsToLegs.handleEvent(), and org.matsim.core.router.TeleportationRoutingModule.toString().

◆ setTravelTimeUndefined()

void org.matsim.api.core.v01.population.Route.setTravelTimeUndefined ( )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

◆ getStartLinkId()

Id<Link> org.matsim.api.core.v01.population.Route.getStartLinkId ( )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.core.mobsim.qsim.pt.TransitDriverAgentImpl.PlanBuilder.addTrip(), org.matsim.pt.UmlaufInterpolator.addUmlaufStueckToUmlauf(), org.matsim.core.population.routes.RouteUtils.calcDistance(), org.matsim.core.population.routes.RouteUtils.calcTravelTime(), org.matsim.core.mobsim.hermes.ScenarioImporter.TransitRouteContext.calculateSpeedsBetweenStops(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.chooseNextLinkId(), org.matsim.core.mobsim.qsim.pt.TransitQSimEngine.createAndScheduleVehicleAndDriver(), org.matsim.core.router.TransitRouterWrapper.fillWithActivities(), org.matsim.core.mobsim.qsim.agents.PopulationAgentSource.findVehicleLink(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.getCurrentLinkId(), org.matsim.analysis.TripsAndLegsWriter.getLegRecord(), org.matsim.core.population.routes.RouteUtils.getNodes(), org.matsim.withinday.utils.EditRoutes.getRouteLinkIds(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getStartLinkId(), org.matsim.core.population.routes.RouteUtils.getSubRoute(), org.matsim.withinday.utils.EditRoutes.relocateCurrentLegRoute(), org.matsim.withinday.utils.EditRoutes.replanFutureLegRoute(), org.matsim.analysis.CalcAverageTripLength.run(), org.matsim.pt.utils.TransitScheduleValidator.validateNetworkRoutes(), and org.matsim.pt.utils.TransitScheduleValidator.validateStopsOnNetworkRoute().

◆ getEndLinkId()

Id<Link> org.matsim.api.core.v01.population.Route.getEndLinkId ( )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.core.mobsim.qsim.pt.TransitDriverAgentImpl.PlanBuilder.addTrip(), org.matsim.pt.UmlaufInterpolator.addUmlaufStueckToUmlauf(), org.matsim.core.population.routes.RouteUtils.calcDistance(), org.matsim.core.population.routes.RouteUtils.calcTravelTime(), org.matsim.core.mobsim.hermes.ScenarioImporter.TransitRouteContext.calculateSpeedsBetweenStops(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.chooseNextLinkId(), ch.sbb.matsim.routing.pt.raptor.SwissRailRaptorRoutingModule.findCoordinate(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.getCurrentLinkId(), org.matsim.core.mobsim.qsim.agents.BasicPlanAgentImpl.getDestinationLinkId(), org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getEndLinkId(), org.matsim.analysis.TripsAndLegsWriter.getLegRecord(), org.matsim.core.population.routes.RouteUtils.getNodes(), org.matsim.withinday.utils.EditRoutes.getRouteLinkIds(), org.matsim.core.population.routes.RouteUtils.getSubRoute(), org.matsim.withinday.utils.EditTrips.replaceRemainderOfCurrentRoute(), org.matsim.withinday.utils.EditRoutes.replanCurrentLegRoute(), org.matsim.withinday.utils.EditRoutes.replanFutureLegRoute(), org.matsim.analysis.CalcAverageTripLength.run(), and org.matsim.pt.utils.TransitScheduleValidator.validateStopsOnNetworkRoute().

◆ setStartLinkId()

void org.matsim.api.core.v01.population.Route.setStartLinkId ( final Id< Link > linkId )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

◆ setEndLinkId()

void org.matsim.api.core.v01.population.Route.setEndLinkId ( final Id< Link > linkId )

inherited

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractRoute, and org.matsim.core.population.routes.AbstractNetworkRoute.

◆ getRouteDescription()

String org.matsim.api.core.v01.population.Route.getRouteDescription ( )

inherited

Returns: a serialization of this routes state as a String. Used to write the route to files.

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractNetworkRoute, org.matsim.pt.routes.ExperimentalTransitRoute, org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.core.population.routes.GenericRouteImpl.

Referenced by org.matsim.core.mobsim.qsim.agents.TransitAgentImpl.getDesiredAccessStopId(), and org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getRouteDescription().

◆ setRouteDescription()

void org.matsim.api.core.v01.population.Route.setRouteDescription ( final String routeDescription )

inherited

Sets the state of the route based on it's description

Parameters

routeDescription

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractNetworkRoute, org.matsim.pt.routes.ExperimentalTransitRoute, org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.core.population.routes.GenericRouteImpl.

◆ getRouteType()

String org.matsim.api.core.v01.population.Route.getRouteType ( )

inherited

Returns: an identifier describing the type of this route uniquely. Used when writing the route to files.

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.core.population.routes.AbstractNetworkRoute, org.matsim.pt.routes.ExperimentalTransitRoute, org.matsim.pt.routes.DefaultTransitPassengerRoute, and org.matsim.core.population.routes.GenericRouteImpl.

Referenced by org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper.getRouteType().

◆ clone()

Route org.matsim.api.core.v01.population.Route.clone ( )

inherited

make the clone method public, but do NOT extend Cloneable so that implementations can decide on their own if they support Cloneable or use some other way to make a copy..

Design comments:

Do we really want this? Martin ("Clean code") argues for the difference between data objects and behavioral objects. Data objects should only be accessed via the interface methods. I think that "route" is a data object. In consequence, "copy" and/or "deepCopy" should, in my view, be static methods. (The argument against this is, I guess, that one might want to add Route implementations that are not part of the standard. Yet given that we want to be able to read/write them in xml, I am not sure how far this carries.) kai, jan'13
In our particular situation, "clone" may be considered as a useful approach to our problem (first clone the plan or its elements, then mutate the contents). Having clone but not Cloneable in the API leaves implementing classes the choice to implement it via Cloneable or via other means. kai, dec'15

Implemented in org.matsim.core.mobsim.qsim.pt.AbstractTransitDriverAgent.NetworkRouteWrapper, org.matsim.pt.routes.DefaultTransitPassengerRoute, org.matsim.core.population.routes.AbstractRoute, org.matsim.core.population.routes.NetworkRoute, org.matsim.core.population.routes.mediumcompressed.MediumCompressedNetworkRoute, org.matsim.pt.routes.ExperimentalTransitRoute, org.matsim.core.population.routes.heavycompressed.HeavyCompressedNetworkRoute, org.matsim.core.population.routes.GenericRouteImpl, and org.matsim.core.population.routes.AbstractNetworkRoute.

Referenced by org.matsim.core.population.PopulationUtils.copyFromTo().

The documentation for this interface was generated from the following file: