org.matsim.pt.analysis.RouteOccupancy Class Reference

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

Public Member Functions
	RouteOccupancy (final TransitRoute transitRoute, final VehicleTracker tracker)
void	handleEvent (final PersonEntersVehicleEvent event)
void	handleEvent (final PersonLeavesVehicleEvent event)
void	reset (final int iteration)
int	getNumberOfEnteringPassengers (final Id stopFacilityId)
int	getNumberOfLeavingPassengers (final Id stopFacilityId)

Private Member Functions
void	collectVehiclesInfo ()

Private Attributes
final TransitRoute	transitRoute
final VehicleTracker	tracker
Set< Id >	routeVehicles = null
final Map< Id, Integer >	enteringPassengers = new HashMap<Id, Integer>()
final Map< Id, Integer >	leavingPassengers = new HashMap<Id, Integer>()

Static Private Attributes
static final Integer	Int1 = Integer.valueOf(1)

Detailed Description

Keeps track of the total number of passengers entering and leaving a transit vehicle along a given route, on all Departures.

Author

mrieser

Definition at line 42 of file RouteOccupancy.java.

Constructor & Destructor Documentation

RouteOccupancy()

org.matsim.pt.analysis.RouteOccupancy.RouteOccupancy	(	final TransitRoute	transitRoute,
		final VehicleTracker	tracker
	)

Definition at line 52 of file RouteOccupancy.java.

References org.matsim.pt.analysis.RouteOccupancy.tracker, and org.matsim.pt.analysis.RouteOccupancy.transitRoute.

                                                                                         {
        this.transitRoute = transitRoute;
        this.tracker = tracker;
    }

Member Function Documentation

handleEvent() [1/2]

void org.matsim.pt.analysis.RouteOccupancy.handleEvent

(

final PersonEntersVehicleEvent

event

)

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

Definition at line 57 of file RouteOccupancy.java.

References org.matsim.pt.analysis.RouteOccupancy.collectVehiclesInfo(), org.matsim.api.core.v01.Id< T >.get(), org.matsim.pt.analysis.VehicleTracker.getFacilityIdForVehicle(), and org.matsim.api.core.v01.events.PersonEntersVehicleEvent.getVehicleId().

                                                                  {
        if (this.routeVehicles == null) {
            collectVehiclesInfo();
        }
        if (this.routeVehicles.contains(event.getVehicleId())) {
            Id facilityId = this.tracker.getFacilityIdForVehicle(event.getVehicleId());
            Integer count = this.enteringPassengers.get(facilityId);
            if (count == null) {
                this.enteringPassengers.put(facilityId, Int1);
            } else {
                this.enteringPassengers.put(facilityId, Integer.valueOf(1 + count.intValue()));
            }
        }
    }

Here is the call graph for this function:

handleEvent() [2/2]

void org.matsim.pt.analysis.RouteOccupancy.handleEvent

(

final PersonLeavesVehicleEvent

event

)

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

Definition at line 72 of file RouteOccupancy.java.

References org.matsim.pt.analysis.RouteOccupancy.collectVehiclesInfo(), org.matsim.api.core.v01.Id< T >.get(), org.matsim.pt.analysis.VehicleTracker.getFacilityIdForVehicle(), and org.matsim.api.core.v01.events.PersonLeavesVehicleEvent.getVehicleId().

                                                                  {
        if (this.routeVehicles == null) {
            collectVehiclesInfo();
        }
        if (this.routeVehicles.contains(event.getVehicleId())) {
            Id facilityId = this.tracker.getFacilityIdForVehicle(event.getVehicleId());
            Integer count = this.leavingPassengers.get(facilityId);
            if (count == null) {
                this.leavingPassengers.put(facilityId, Int1);
            } else {
                this.leavingPassengers.put(facilityId, Integer.valueOf(1 + count.intValue()));
            }
        }
    }

Here is the call graph for this function:

reset()

void org.matsim.pt.analysis.RouteOccupancy.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 87 of file RouteOccupancy.java.

                                           {
        this.routeVehicles = null;
        this.enteringPassengers.clear();
        this.leavingPassengers.clear();
    }

getNumberOfEnteringPassengers()

int org.matsim.pt.analysis.RouteOccupancy.getNumberOfEnteringPassengers

(

final Id

stopFacilityId

)

Definition at line 93 of file RouteOccupancy.java.

                                                                      {
        Integer count = this.enteringPassengers.get(stopFacilityId);
        if (count == null) {
            return 0;
        }
        return count.intValue();
    }

getNumberOfLeavingPassengers()

int org.matsim.pt.analysis.RouteOccupancy.getNumberOfLeavingPassengers

(

final Id

stopFacilityId

)

Definition at line 101 of file RouteOccupancy.java.

                                                                     {
        Integer count = this.leavingPassengers.get(stopFacilityId);
        if (count == null) {
            return 0;
        }
        return count.intValue();
    }

collectVehiclesInfo()

void org.matsim.pt.analysis.RouteOccupancy.collectVehiclesInfo ( )

private

Lazy initialization, as the vehicle info may not be available from the beginning.

Definition at line 112 of file RouteOccupancy.java.

References org.matsim.pt.transitSchedule.api.TransitRoute.getDepartures().

Referenced by org.matsim.pt.analysis.RouteOccupancy.handleEvent().

                                       {
        Set<Id> set = new HashSet<Id>(this.transitRoute.getDepartures().size()*2);

        for (Departure departure : this.transitRoute.getDepartures().values()) {
            if (departure.getVehicleId() != null) {
                set.add(departure.getVehicleId());
            }
        }

        /* try to make it thread-safe by assigning class-member at the end.
         * if two threads enter this method, nothing bad should happen,
         * as both threads should generated the same initialization.
         */
        this.routeVehicles = set;
    }

Here is the call graph for this function:

Member Data Documentation

Int1

final Integer org.matsim.pt.analysis.RouteOccupancy.Int1 = Integer.valueOf(1)

staticprivate

Definition at line 44 of file RouteOccupancy.java.

transitRoute

final TransitRoute org.matsim.pt.analysis.RouteOccupancy.transitRoute

private

Definition at line 46 of file RouteOccupancy.java.

Referenced by org.matsim.pt.analysis.RouteOccupancy.RouteOccupancy().

tracker

final VehicleTracker org.matsim.pt.analysis.RouteOccupancy.tracker

private

Definition at line 47 of file RouteOccupancy.java.

Referenced by org.matsim.pt.analysis.RouteOccupancy.RouteOccupancy().

routeVehicles

Set<Id> org.matsim.pt.analysis.RouteOccupancy.routeVehicles = null

private

Definition at line 48 of file RouteOccupancy.java.

enteringPassengers

final Map<Id, Integer> org.matsim.pt.analysis.RouteOccupancy.enteringPassengers = new HashMap<Id, Integer>()

private

Definition at line 49 of file RouteOccupancy.java.

leavingPassengers

final Map<Id, Integer> org.matsim.pt.analysis.RouteOccupancy.leavingPassengers = new HashMap<Id, Integer>()

private

Definition at line 50 of file RouteOccupancy.java.

---

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

• pt/analysis/RouteOccupancy.java