org.matsim.pt.analysis.TransitLoad Class Reference

Inheritance diagram for org.matsim.pt.analysis.TransitLoad:

Classes
class	LineData
class	RouteData
class	StopData
class	StopInformation
class	VehicleData

Public Member Functions
	TransitLoad ()
int	getLoadAtDeparture (final TransitLine line, final TransitRoute route, final TransitStopFacility stopFacility, final Departure departure)
int	getLoadAtDeparture (final TransitLine line, final TransitRoute route, final int transitRouteStopIndex, final Departure departure)
List< StopInformation >	getDepartureStopInformation (final TransitLine line, final TransitRoute route, final TransitStopFacility stopFacility, final Departure departure)
void	handleEvent (TransitDriverStartsEvent event)
void	handleEvent (final VehicleArrivesAtFacilityEvent event)
void	handleEvent (final VehicleDepartsAtFacilityEvent event)
void	handleEvent (final PersonEntersVehicleEvent event)
void	handleEvent (final PersonLeavesVehicleEvent event)
void	reset (final int iteration)

Private Member Functions
List< StopInformation >	getStopInformation (final Id< TransitLine > lineId, final Id< TransitRoute > routeId, final Id< TransitStopFacility > stopFacilityId, final Id< Departure > departureId, final boolean createIfMissing)

Private Attributes
final Map< Id< TransitLine >, LineData >	lineData = new HashMap<>()
final Map< Id< Vehicle >, Id< TransitStopFacility > >	vehicleFacilityMap = new HashMap<>()
final Map< Id< Vehicle >, VehicleData >	vehicleData = new HashMap<>()

Detailed Description

Calculates the number of passenger that are in a transit vehicle when the vehicle departs a stop location.

Author

mrieser

Definition at line 52 of file TransitLoad.java.

Constructor & Destructor Documentation

TransitLoad()

org.matsim.pt.analysis.TransitLoad.TransitLoad

(

)

Definition at line 59 of file TransitLoad.java.

                         {
    }

Member Function Documentation

getLoadAtDeparture() [1/2]

int org.matsim.pt.analysis.TransitLoad.getLoadAtDeparture	(	final TransitLine	line,
		final TransitRoute	route,
		final TransitStopFacility	stopFacility,
		final Departure	departure
	)

Always returns first occurence of the TransitStopFacility in the route.

Parameters

line
route
stopFacility
departure

Returns

Definition at line 72 of file TransitLoad.java.

References org.matsim.api.core.v01.Identifiable< T >.getId(), and org.matsim.pt.transitSchedule.api.TransitRoute.getStops().

                                                                                                                                                       {
        for (int i = 0; i < route.getStops().size(); i++) {
            if (route.getStops().get(i).getStopFacility().getId().equals(stopFacility.getId())) {
                return getLoadAtDeparture(line, route, i, departure);
            }
        }
        return -1;
    }

Here is the call graph for this function:

getLoadAtDeparture() [2/2]

int org.matsim.pt.analysis.TransitLoad.getLoadAtDeparture	(	final TransitLine	line,
		final TransitRoute	route,
		final int	transitRouteStopIndex,
		final Departure	departure
	)

Definition at line 81 of file TransitLoad.java.

References org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.pt.transitSchedule.api.TransitRouteStop.getStopFacility(), org.matsim.pt.analysis.TransitLoad.getStopInformation(), org.matsim.pt.transitSchedule.api.TransitRoute.getStops(), org.matsim.pt.analysis.TransitLoad.StopInformation.nOfEntering, and org.matsim.pt.analysis.TransitLoad.StopInformation.nOfLeaving.

                                                                                                                                                {
        int nOfPassengers = 0;

        /*
         * count how often a stop was visited while following the route in
         * route.getStops() to differentiate multiple servings of the same
         * TransitStopFacility. Count from 0, so count equals index in list
         */
        Map<Id<TransitStopFacility>, Integer> stop2nrVisited = new HashMap<>();
        for (int i = 0; i < route.getStops().size(); i++) {
            TransitRouteStop stop = route.getStops().get(i);
            Integer nrVisited = stop2nrVisited.get(stop.getStopFacility().getId());
            if (nrVisited == null) {
                nrVisited = 0;
            } else {
                nrVisited++;
            }
            stop2nrVisited.put(stop.getStopFacility().getId(), nrVisited);

            List<StopInformation> siList = getStopInformation(line.getId(), route.getId(), stop.getStopFacility().getId(), departure.getId(), false);
            if (siList != null) {
                StopInformation si = siList.get(nrVisited);
                if (si != null) {
                    nOfPassengers -= si.nOfLeaving;
                    nOfPassengers += si.nOfEntering;
                }
            }
            if (i == transitRouteStopIndex) {
                return nOfPassengers;
            }
        }
        return -1;
    }

Here is the call graph for this function:

getDepartureStopInformation()

List<StopInformation> org.matsim.pt.analysis.TransitLoad.getDepartureStopInformation	(	final TransitLine	line,
		final TransitRoute	route,
		final TransitStopFacility	stopFacility,
		final Departure	departure
	)

Definition at line 115 of file TransitLoad.java.

References org.matsim.api.core.v01.Identifiable< T >.getId(), and org.matsim.pt.analysis.TransitLoad.getStopInformation().

                                                                                                                                                                                  {
        return getStopInformation(line.getId(), route.getId(), stopFacility.getId(), departure.getId(), false);
    }

Here is the call graph for this function:

handleEvent() [1/5]

void org.matsim.pt.analysis.TransitLoad.handleEvent

(

TransitDriverStartsEvent

event

)

Implements org.matsim.api.core.v01.events.handler.TransitDriverStartsEventHandler.

Definition at line 120 of file TransitLoad.java.

References org.matsim.api.core.v01.events.TransitDriverStartsEvent.getVehicleId().

                                                            {
        this.vehicleData.put(event.getVehicleId(), new VehicleData(event.getVehicleId(), event.getTransitLineId(), event.getTransitRouteId(), event.getDepartureId(), event.getDriverId()));
    }

Here is the call graph for this function:

handleEvent() [2/5]

void org.matsim.pt.analysis.TransitLoad.handleEvent

(

final VehicleArrivesAtFacilityEvent

event

)

Implements org.matsim.core.api.experimental.events.handler.VehicleArrivesAtFacilityEventHandler.

Definition at line 125 of file TransitLoad.java.

References org.matsim.pt.analysis.TransitLoad.StopInformation.arrivalTime, org.matsim.pt.analysis.TransitLoad.VehicleData.departureId, org.matsim.pt.analysis.TransitLoad.getStopInformation(), org.matsim.core.api.experimental.events.VehicleArrivesAtFacilityEvent.getVehicleId(), org.matsim.pt.analysis.TransitLoad.VehicleData.lineId, and org.matsim.pt.analysis.TransitLoad.VehicleData.routeId.

                                                                       {
        this.vehicleFacilityMap.put(event.getVehicleId(), event.getFacilityId());
        VehicleData vData = this.vehicleData.get(event.getVehicleId());
        if (vData != null) {
            List<StopInformation> siList = getStopInformation(vData.lineId, vData.routeId, this.vehicleFacilityMap.get(event.getVehicleId()), vData.departureId, true);
            // Vehicle arrives at facility -> begin of serving the stop (once more) -> create new StopInformation
            StopInformation si = new StopInformation();
            si.arrivalTime = event.getTime();
            siList.add(si);
        }
    }

Here is the call graph for this function:

handleEvent() [3/5]

void org.matsim.pt.analysis.TransitLoad.handleEvent

(

final VehicleDepartsAtFacilityEvent

event

)

Implements org.matsim.core.api.experimental.events.handler.VehicleDepartsAtFacilityEventHandler.

Definition at line 138 of file TransitLoad.java.

References org.matsim.pt.analysis.TransitLoad.VehicleData.departureId, org.matsim.pt.analysis.TransitLoad.StopInformation.departureTime, org.matsim.pt.analysis.TransitLoad.getStopInformation(), org.matsim.core.api.experimental.events.VehicleDepartsAtFacilityEvent.getVehicleId(), org.matsim.pt.analysis.TransitLoad.VehicleData.lineId, and org.matsim.pt.analysis.TransitLoad.VehicleData.routeId.

                                                                       {
        Id<TransitStopFacility> stopId = this.vehicleFacilityMap.remove(event.getVehicleId());
        VehicleData vData = this.vehicleData.get(event.getVehicleId());
        if (vData != null) {
            List<StopInformation> siList = getStopInformation(vData.lineId, vData.routeId, stopId, vData.departureId, true);
            // Vehicle is already at facility -> add information to last StopInformation
            StopInformation si = siList.get(siList.size() - 1);
            si.departureTime = event.getTime();
        }
    }

Here is the call graph for this function:

handleEvent() [4/5]

void org.matsim.pt.analysis.TransitLoad.handleEvent

(

final PersonEntersVehicleEvent

event

)

Implements org.matsim.api.core.v01.events.handler.PersonEntersVehicleEventHandler.

Definition at line 150 of file TransitLoad.java.

References org.matsim.pt.analysis.TransitLoad.VehicleData.departureId, org.matsim.pt.analysis.TransitLoad.VehicleData.driverId, org.matsim.api.core.v01.events.PersonEntersVehicleEvent.getPersonId(), org.matsim.pt.analysis.TransitLoad.getStopInformation(), org.matsim.api.core.v01.events.PersonEntersVehicleEvent.getVehicleId(), org.matsim.pt.analysis.TransitLoad.VehicleData.lineId, org.matsim.pt.analysis.TransitLoad.StopInformation.nOfEntering, and org.matsim.pt.analysis.TransitLoad.VehicleData.routeId.

                                                                  {
        VehicleData vData = this.vehicleData.get(event.getVehicleId());
        if (vData != null) {
            if (!vData.driverId.equals(event.getPersonId())) {
                List<StopInformation> siList = getStopInformation(vData.lineId, vData.routeId,
                        this.vehicleFacilityMap.get(event.getVehicleId()), vData.departureId, true);
                // Vehicle is already at facility -> add information to last StopInformation
                StopInformation si = siList.get(siList.size() - 1);
                si.nOfEntering++;
            }
        }
    }

Here is the call graph for this function:

handleEvent() [5/5]

void org.matsim.pt.analysis.TransitLoad.handleEvent

(

final PersonLeavesVehicleEvent

event

)

Implements org.matsim.api.core.v01.events.handler.PersonLeavesVehicleEventHandler.

Definition at line 164 of file TransitLoad.java.

References org.matsim.pt.analysis.TransitLoad.VehicleData.departureId, org.matsim.pt.analysis.TransitLoad.VehicleData.driverId, org.matsim.api.core.v01.events.PersonLeavesVehicleEvent.getPersonId(), org.matsim.pt.analysis.TransitLoad.getStopInformation(), org.matsim.api.core.v01.events.PersonLeavesVehicleEvent.getVehicleId(), org.matsim.pt.analysis.TransitLoad.VehicleData.lineId, org.matsim.pt.analysis.TransitLoad.StopInformation.nOfLeaving, and org.matsim.pt.analysis.TransitLoad.VehicleData.routeId.

                                                                  {
        VehicleData vData = this.vehicleData.get(event.getVehicleId());
        if (vData != null) {
            if (!vData.driverId.equals(event.getPersonId())) {
                List<StopInformation> siList = getStopInformation(vData.lineId, vData.routeId,
                        this.vehicleFacilityMap.get(event.getVehicleId()), vData.departureId, true);
                // Vehicle is already at facility -> add information to last StopInformation
                StopInformation si = siList.get(siList.size() - 1);
                si.nOfLeaving++;
            }
        }
    }

Here is the call graph for this function:

reset()

void org.matsim.pt.analysis.TransitLoad.reset

(

final int

iteration

)

Gives the event handler the possibility to clean up its internal state. Within a Controler-Simulation, this is called before the mobsim starts.

Parameters

iteration

the up-coming iteration from which up-coming events will be from.

Implements org.matsim.core.events.handler.EventHandler.

Definition at line 178 of file TransitLoad.java.

                                           {
        this.vehicleFacilityMap.clear();
        this.vehicleData.clear();
    }

getStopInformation()

List<StopInformation> org.matsim.pt.analysis.TransitLoad.getStopInformation ( final Id< TransitLine >  lineId, final Id< TransitRoute >  routeId, final Id< TransitStopFacility >  stopFacilityId, final Id< Departure >  departureId, final boolean  createIfMissing  )

private

Definition at line 183 of file TransitLoad.java.

Referenced by org.matsim.pt.analysis.TransitLoad.getDepartureStopInformation(), org.matsim.pt.analysis.TransitLoad.getLoadAtDeparture(), and org.matsim.pt.analysis.TransitLoad.handleEvent().

                                                                                                                                                                                                                                 {
        LineData ld = this.lineData.get(lineId);
        if (ld == null) {
            if (createIfMissing) {
                ld = new LineData();
                this.lineData.put(lineId, ld);
            } else {
                return null;
            }
        }

        RouteData rd = ld.routeData.get(routeId);
        if (rd == null) {
            if (createIfMissing) {
                rd = new RouteData();
                ld.routeData.put(routeId, rd);
            } else {
                return null;
            }
        }

        StopData sd = rd.stopData.get(stopFacilityId);
        if (sd == null) {
            if (createIfMissing) {
                sd = new StopData();
                rd.stopData.put(stopFacilityId, sd);
            } else {
                return null;
            }
        }

        List<StopInformation> siList = sd.departureData.get(departureId);
        if (siList == null) {
            if (createIfMissing) {
                siList = new ArrayList<>();
                sd.departureData.put(departureId, siList);
            } else {
                return null;
            }
        }
        return siList;
    }

Member Data Documentation

lineData

final Map<Id<TransitLine>, LineData> org.matsim.pt.analysis.TransitLoad.lineData = new HashMap<>()

private

Definition at line 54 of file TransitLoad.java.

vehicleFacilityMap

final Map<Id<Vehicle>, Id<TransitStopFacility> > org.matsim.pt.analysis.TransitLoad.vehicleFacilityMap = new HashMap<>()

private

Definition at line 56 of file TransitLoad.java.

vehicleData

final Map<Id<Vehicle>, VehicleData> org.matsim.pt.analysis.TransitLoad.vehicleData = new HashMap<>()

private

Definition at line 57 of file TransitLoad.java.

---

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

• pt/analysis/TransitLoad.java