Inheritance diagram for org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility:

Public Member Functions
	TransitRouterNetworkTravelTimeAndDisutility (final TransitRouterConfig config)

	TransitRouterNetworkTravelTimeAndDisutility (final TransitRouterConfig config, PreparedTransitSchedule preparedTransitSchedule)

double	getLinkTravelDisutility (final Link link, final double time, final Person person, final Vehicle vehicle, final CustomDataManager dataManager)

double	getLinkTravelTime (final Link link, final double time, Person person, Vehicle vehicle)

double	getVehArrivalTime (final Link link, final double now)

double	getWalkTravelDisutility (Person person, Coord coord, Coord toCoord)

double	getWalkTravelTime (Person person, Coord coord, Coord toCoord)

Protected Member Functions
double	offVehicleWaitTime (final Link link, final double time)

final double	defaultTransferCost (final Link link, final double time, final Person person, final Vehicle vehicle)

Protected Attributes
final TransitRouterConfig	config

Private Attributes
Link	previousLink = null

double	previousTime = Double.NaN

double	cachedTravelTime = Double.NaN

final PreparedTransitSchedule	preparedTransitSchedule

Detailed Description

TravelTime and TravelCost calculator to be used with the transit network used for transit routing.

This class is NOT thread-safe!

Author: mrieser

Definition at line 39 of file TransitRouterNetworkTravelTimeAndDisutility.java.

Constructor & Destructor Documentation

◆ TransitRouterNetworkTravelTimeAndDisutility() [1/2]

org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.TransitRouterNetworkTravelTimeAndDisutility ( final TransitRouterConfig config )

Definition at line 57 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.config.

                                                                                          {
         this(config, new PreparedTransitSchedule());
     }

◆ TransitRouterNetworkTravelTimeAndDisutility() [2/2]

org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.TransitRouterNetworkTravelTimeAndDisutility	(	final TransitRouterConfig	config,
		PreparedTransitSchedule	preparedTransitSchedule
	)

Definition at line 61 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.config, and org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.preparedTransitSchedule.

                                                                                                                                           {
         this.config = config;
         this.preparedTransitSchedule = preparedTransitSchedule;
     }

Member Function Documentation

◆ getLinkTravelDisutility()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelDisutility	(	final Link	link,
		final double	time,
		final Person	person,
		final Vehicle	vehicle,
		final CustomDataManager	dataManager
	)

Returns the disutility to travel on the specified link at the specified time.

Parameters

link	The link for which the travel disutility is calculated.
time	The departure time (in seconds since 00:00) at the beginning of the link for which the disutility is calculated.
person	The person that wants to travel along the link. Note that this parameter can be `null`!
vehicle	The vehicle with which the person wants to travel along the link. Note that this parameter can be `null`!
dataManager	A helper class to enable the cost calculator store arbitrary data during one routing request.

Returns: The disutility to travel over the link link, departing at time time.

Implements org.matsim.pt.router.TransitTravelDisutility.

Definition at line 67 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.defaultTransferCost(), org.matsim.pt.router.TransitRouterNetwork.TransitRouterNetworkLink.getLength(), org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelTime(), org.matsim.pt.router.TransitRouterConfig.getMarginalUtilityOfTravelDistancePt_utl_m(), org.matsim.pt.router.TransitRouterConfig.getMarginalUtilityOfTravelTimePt_utl_s(), org.matsim.pt.router.TransitRouterConfig.getMarginalUtilityOfWaitingPt_utl_s(), and org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.offVehicleWaitTime().

                                                                                                                                                                {
         double cost;
         if (((TransitRouterNetworkLink) link).getRoute() == null) {
             // "route" here means "pt route".  If no pt route is attached, it means that it is a transfer link.
 
             cost = defaultTransferCost(link, time, person, vehicle);
             
         } else {
             double offVehWaitTime = offVehicleWaitTime(link, time);     
             double inVehTime = getLinkTravelTime(link,time, person, vehicle) - offVehWaitTime;      
             cost = - inVehTime       * this.config.getMarginalUtilityOfTravelTimePt_utl_s() 
                    -offVehWaitTime   * this.config.getMarginalUtilityOfWaitingPt_utl_s()
                    -link.getLength() * this.config.getMarginalUtilityOfTravelDistancePt_utl_m();
 
         }
         return cost;
     }

Here is the call graph for this function:

◆ offVehicleWaitTime()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.offVehicleWaitTime	(	final Link	link,
		final double	time
	)

protected

method to allow inclusion of offVehicleWaitTime without code replication. kai, oct'12

Parameters

link
time

Returns

Definition at line 92 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getVehArrivalTime().

Referenced by org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelDisutility().

                                                                             {
         double offVehWaitTime=0;
         double nextVehArrivalTime = getVehArrivalTime(link, time);
         if (time < nextVehArrivalTime){ // it means the agent waits outside the veh             
             offVehWaitTime = nextVehArrivalTime-time;
         }
         return offVehWaitTime;
 
     }

Here is the call graph for this function:

◆ defaultTransferCost()

final double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.defaultTransferCost	(	final Link	link,
		final double	time,
		final Person	person,
		final Vehicle	vehicle
	)

protected

convenience method for derived classes in order to bring Manuel's version closer to this one here. kai, oct'12

Definition at line 106 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterConfig.getAdditionalTransferTime(), and org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelTime().

Referenced by org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelDisutility().

                                                         {
         double cost;
         double transfertime = getLinkTravelTime(link, time, person, vehicle);
         double waittime = this.config.getAdditionalTransferTime();
         
         // say that the effective walk time is the transfer time minus some "buffer"
         double walktime = transfertime - waittime;
         // (this looks like walktime might become negative.  But at least in the default version, the additional transfer time is always
         // _added_ to the walk time (see getLinkTravelTime below) so at least in that case this cannot happen.  kai, triggered by cd, may'16)
         if ( walktime < 0. ) {
             throw new RuntimeException( "negative walk time; should not happen; needs to be repaired" ) ;
         }
         
         double walkDistance = link.getLength();
         
         // weigh this "buffer" not with the walk time disutility, but with the wait time disutility:
         // (note that this is the same "additional disutl of wait" as in the scoring function.  Its default is zero.
         // only if you are "including the opportunity cost of time into the router", then the disutility of waiting will
         // be the same as the marginal opprotunity cost of time).  kai, nov'11
         cost = - walktime * this.config.getMarginalUtilityOfTravelTimeWalk_utl_s()
                - walkDistance * this.config.getMarginalUtilityOfTravelDistanceWalk_utl_m() 
                - waittime * this.config.getMarginalUtilityOfWaitingPt_utl_s()
                - this.config.getUtilityOfLineSwitch_utl();
         return cost;
     }

Here is the call graph for this function:

◆ getLinkTravelTime()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelTime	(	final Link	link,
		final double	time,
		Person	person,
		Vehicle	vehicle
	)

Returns the travel time for the specified link at the specified time.

Parameters

link	The link for which the travel time is calculated.
time	The departure time (in seconds since 00:00) at the beginning of the link for which the travel time is calculated.
person	TODO
vehicle	TODO

Returns: The time (in seconds) needed to travel over the link link, departing at time time.

Implements org.matsim.core.router.util.TravelTime.

Definition at line 134 of file TransitRouterNetworkTravelTimeAndDisutility.java.

Referenced by org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.defaultTransferCost(), and org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getLinkTravelDisutility().

                                                                                                         {
         if ((link == this.previousLink) && (time == this.previousTime)) {
             return this.cachedTravelTime;
         }
         this.previousLink = link;
         this.previousTime = time;
 
         TransitRouterNetworkLink wrapped = (TransitRouterNetworkLink) link;
         TransitRouteStop fromStop = wrapped.fromNode.stop;
         TransitRouteStop toStop = wrapped.toNode.stop;
         if (wrapped.route != null) {
             // (agent stays on the same route, so use transit line travel time)
             
             // get the next departure time:
             double bestDepartureTime = preparedTransitSchedule.getNextDepartureTime(wrapped.route, fromStop, time);
 
             // the travel time on the link is 
             //   the time until the departure (``dpTime - now'')
             //   + the travel time on the link (there.arrivalTime - here.departureTime)
             // But quite often, we only have the departure time at the next stop.  Then we use that:
             double arrivalOffset = toStop.getArrivalOffset().or(toStop::getDepartureOffset).seconds();
             double time2 = (bestDepartureTime - time) + (arrivalOffset - fromStop.getDepartureOffset().seconds());
             if (time2 < 0) {
                 // ( this can only happen, I think, when ``bestDepartureTime'' is after midnight but ``time'' was before )
                 time2 += MIDNIGHT;
             }
             this.cachedTravelTime = time2;
             return time2;
         }
         // different transit routes, so it must be a line switch
         double distance = wrapped.getLength();
         double time2 = distance / this.config.getBeelineWalkSpeed() + this.config.getAdditionalTransferTime();
         this.cachedTravelTime = time2;
         return time2;
     }

Here is the call graph for this function:

◆ getVehArrivalTime()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getVehArrivalTime	(	final Link	link,
		final double	now
	)

Definition at line 175 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.pt.router.TransitRouterNetwork.TransitRouterNetworkLink.getRoute().

Referenced by org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.offVehicleWaitTime().

                                                                       {
         if ((link == this.previousWaitLink) && (now == this.previousWaitTime)) {
             return this.cachedVehArrivalTime;
         }
         this.previousWaitLink = link;
         this.previousWaitTime = now;
         
         //first find out vehicle arrival time to fromStop according to transit schedule
         TransitRouterNetworkLink wrapped = (TransitRouterNetworkLink) link;
         if (wrapped.getRoute() == null) { 
             throw new RuntimeException("should not happen") ;
         }
         TransitRouteStop fromStop = wrapped.fromNode.stop;
         
         double nextDepartureTime = preparedTransitSchedule.getNextDepartureTime(wrapped.getRoute(), fromStop, now);
 
         double fromStopDepartureOffset = fromStop.getDepartureOffset().seconds();
         double fromStopArrivalOffset = fromStop.getArrivalOffset().orElse(fromStopDepartureOffset);
         double vehWaitAtStopTime = fromStopDepartureOffset - fromStopArrivalOffset; //time in which the veh stops at station
         double vehArrivalTime = nextDepartureTime - vehWaitAtStopTime;
         cachedVehArrivalTime = vehArrivalTime ;
         return vehArrivalTime ;     
     }

Here is the call graph for this function:

◆ getWalkTravelDisutility()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getWalkTravelDisutility	(	Person	person,
		Coord	coord,
		Coord	toCoord
	)

Implements org.matsim.pt.router.TransitTravelDisutility.

Definition at line 200 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.core.utils.geometry.CoordUtils.calcEuclideanDistance(), org.matsim.pt.router.TransitRouterConfig.getBeelineDistanceFactor(), org.matsim.pt.router.TransitRouterConfig.getMarginalUtilityOfTravelDistanceWalk_utl_m(), org.matsim.pt.router.TransitRouterConfig.getMarginalUtilityOfTravelTimeWalk_utl_s(), and org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getWalkTravelTime().

                                                                                      {
         //  getMarginalUtilityOfTravelTimeWalk INCLUDES the opportunity cost of time.  kai, dec'12
         double timeCost = - getWalkTravelTime(person, coord, toCoord) * config.getMarginalUtilityOfTravelTimeWalk_utl_s() ;
         // (sign: margUtl is negative; overall it should be positive because it is a cost.)
         
         double distanceCost = - CoordUtils.calcEuclideanDistance(coord,toCoord) * 
                 config.getBeelineDistanceFactor() * config.getMarginalUtilityOfTravelDistanceWalk_utl_m();
         // (sign: same as above)
         
         return timeCost + distanceCost ;
     }

Here is the call graph for this function:

◆ getWalkTravelTime()

double org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getWalkTravelTime	(	Person	person,
		Coord	coord,
		Coord	toCoord
	)

This is used for walking to and from the nearest transit stop from the start and end location, as well as for the "direct" walk from start to finish without using a pt line at all. It is not used for transfer links (these are handled by the transitTravelDisutility).

Implements org.matsim.pt.router.TransitTravelDisutility.

Definition at line 213 of file TransitRouterNetworkTravelTimeAndDisutility.java.

References org.matsim.core.utils.geometry.CoordUtils.calcEuclideanDistance(), and org.matsim.pt.router.TransitRouterConfig.getBeelineWalkSpeed().

Referenced by org.matsim.pt.router.TransitRouterNetworkTravelTimeAndDisutility.getWalkTravelDisutility().

                                                                                {
         double distance = CoordUtils.calcEuclideanDistance(coord, toCoord);
         double initialTime = distance / config.getBeelineWalkSpeed();
         return initialTime;
     }