org.matsim.pt.counts.OccupancyAnalyzer Class Reference

Inheritance diagram for org.matsim.pt.counts.OccupancyAnalyzer:

Public Member Functions
	OccupancyAnalyzer (final int timeBinSize, final double maxTime)
void	setBoards (Map< Id< TransitStopFacility >, int[]> boards)
void	setAlights (Map< Id< TransitStopFacility >, int[]> alights)
void	setOccupancies (Map< Id< TransitStopFacility >, int[]> occupancies)
int	getTimeSlotIndex (final double time)
void	reset (int iteration)
void	handleEvent (TransitDriverStartsEvent event)
void	handleEvent (PersonEntersVehicleEvent event)
void	handleEvent (PersonLeavesVehicleEvent event)
void	handleEvent (VehicleArrivesAtFacilityEvent event)
void	handleEvent (VehicleDepartsAtFacilityEvent event)
int []	getBoardVolumesForStop (final Id< TransitStopFacility > stopId)
int []	getAlightVolumesForStop (final Id< TransitStopFacility > stopId)
int []	getOccupancyVolumesForStop (final Id< TransitStopFacility > stopId)
Set< Id< TransitStopFacility > >	getBoardStopIds ()
Set< Id< TransitStopFacility > >	getAlightStopIds ()
Set< Id< TransitStopFacility > >	getOccupancyStopIds ()
Set< Id< TransitStopFacility > >	getAllStopIds ()
void	write (String filename)

Private Attributes
final int	timeBinSize
final double	maxTime
Map< Id< TransitStopFacility >, int[]>	boards
final Map< Id< Vehicle >, Id< TransitStopFacility > >	vehStops = new HashMap<>()
final Map< Id< Vehicle >, Integer >	vehPassengers = new HashMap<>()
StringBuffer	occupancyRecord = new StringBuffer("time\tvehId\tStopId\tno.ofPassengersInVeh\n")
final Set< Id< Person > >	transitDrivers = new HashSet<>()
final Set< Id< Vehicle > >	transitVehicles = new HashSet<>()

Static Private Attributes
static final Logger	log = LogManager.getLogger(OccupancyAnalyzer.class)

Detailed Description

Author

yChen

mrieser / senozon

Definition at line 52 of file OccupancyAnalyzer.java.

Constructor & Destructor Documentation

OccupancyAnalyzer()

org.matsim.pt.counts.OccupancyAnalyzer.OccupancyAnalyzer	(	final int	timeBinSize,
		final double	maxTime
	)

Definition at line 71 of file OccupancyAnalyzer.java.

References org.matsim.pt.counts.OccupancyAnalyzer.maxTime, and org.matsim.pt.counts.OccupancyAnalyzer.timeBinSize.

                                                                          {
        this.timeBinSize = timeBinSize;
        this.maxTime = maxTime;
        this.maxSlotIndex = ((int) this.maxTime) / this.timeBinSize + 1;
        this.boards = new IdMap<>(TransitStopFacility.class);
        this.alights = new IdMap<>(TransitStopFacility.class);
        this.occupancies = new IdMap<>(TransitStopFacility.class);
    }

Member Function Documentation

setBoards()

void org.matsim.pt.counts.OccupancyAnalyzer.setBoards

(

Map< Id< TransitStopFacility >, int[]>

boards

)

Definition at line 80 of file OccupancyAnalyzer.java.

References org.matsim.pt.counts.OccupancyAnalyzer.boards.

                                                                      {
        this.boards = boards;
    }

setAlights()

void org.matsim.pt.counts.OccupancyAnalyzer.setAlights

(

Map< Id< TransitStopFacility >, int[]>

alights

)

Definition at line 84 of file OccupancyAnalyzer.java.

                                                                        {
        this.alights = alights;
    }

setOccupancies()

void org.matsim.pt.counts.OccupancyAnalyzer.setOccupancies

(

Map< Id< TransitStopFacility >, int[]>

occupancies

)

Definition at line 88 of file OccupancyAnalyzer.java.

                                                                                {
        this.occupancies = occupancies;
    }

getTimeSlotIndex()

int org.matsim.pt.counts.OccupancyAnalyzer.getTimeSlotIndex

(

final double

time

)

Definition at line 92 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.handleEvent().

                                                   {
        if (time > this.maxTime) {
            return this.maxSlotIndex;
        }
        return ((int) time / this.timeBinSize);
    }

reset()

void org.matsim.pt.counts.OccupancyAnalyzer.reset

(

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 100 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.PtCountControlerListener.notifyBeforeMobsim().

                                     {
        this.boards.clear();
        this.alights.clear();
        this.occupancies.clear();
        this.vehStops.clear();
        this.vehPassengers.clear();
        this.occupancyRecord = new StringBuffer("time\tvehId\tStopId\tno.ofPassengersInVeh\n");
        this.transitDrivers.clear();
        this.transitVehicles.clear();
    }

handleEvent() [1/5]

void org.matsim.pt.counts.OccupancyAnalyzer.handleEvent

(

TransitDriverStartsEvent

event

)

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

Definition at line 112 of file OccupancyAnalyzer.java.

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

                                                            {
        this.transitDrivers.add(event.getDriverId());
        this.transitVehicles.add(event.getVehicleId());
    }

Here is the call graph for this function:

handleEvent() [2/5]

void org.matsim.pt.counts.OccupancyAnalyzer.handleEvent

(

PersonEntersVehicleEvent

event

)

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

Definition at line 118 of file OccupancyAnalyzer.java.

References org.matsim.api.core.v01.Id< T >.get(), org.matsim.api.core.v01.events.PersonEntersVehicleEvent.getPersonId(), org.matsim.pt.counts.OccupancyAnalyzer.getTimeSlotIndex(), and org.matsim.api.core.v01.events.PersonEntersVehicleEvent.getVehicleId().

                                                            {
        if (this.transitDrivers.contains(event.getPersonId()) || !this.transitVehicles.contains(event.getVehicleId())) {
            return; // ignore transit drivers or persons entering non-transit vehicles
        }
        
        Id<Vehicle> vehId = event.getVehicleId();
        Id<TransitStopFacility> stopId = this.vehStops.get(vehId);
        double time = event.getTime();
        // --------------------------getOns---------------------------
        int[] getOn = this.boards.get(stopId);
        if (getOn == null) {
            getOn = new int[this.maxSlotIndex + 1];
            this.boards.put(stopId, getOn);
        }
        getOn[getTimeSlotIndex(time)]++;
        // ------------------------veh_passenger---------------------------
        Integer nPassengers = this.vehPassengers.get(vehId);
        this.vehPassengers.put(vehId, (nPassengers != null) ? (nPassengers + 1) : 1);
        this.occupancyRecord.append("time :\t").append(time).append(" veh :\t").append(vehId).append(" has Passenger\t").append(this.vehPassengers.get(vehId)).append(" \tat stop :\t").append(stopId).append(" ENTERING PERSON :\t").append(event.getPersonId()).append("\n");
    }

Here is the call graph for this function:

handleEvent() [3/5]

void org.matsim.pt.counts.OccupancyAnalyzer.handleEvent

(

PersonLeavesVehicleEvent

event

)

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

Definition at line 140 of file OccupancyAnalyzer.java.

References org.matsim.api.core.v01.Id< T >.get(), org.matsim.api.core.v01.events.PersonLeavesVehicleEvent.getPersonId(), org.matsim.pt.counts.OccupancyAnalyzer.getTimeSlotIndex(), and org.matsim.api.core.v01.events.PersonLeavesVehicleEvent.getVehicleId().

                                                            {
        if (this.transitDrivers.contains(event.getPersonId()) || !this.transitVehicles.contains(event.getVehicleId())) {
            return; // ignore transit drivers or persons entering non-transit vehicles
        }
        
        Id<Vehicle> vehId = event.getVehicleId();
        Id<TransitStopFacility> stopId = this.vehStops.get(vehId);
        double time = event.getTime();
        // --------------------------getDowns---------------------------
        int[] getDown = this.alights.get(stopId);
        if (getDown == null) {
            getDown = new int[this.maxSlotIndex + 1];
            this.alights.put(stopId, getDown);
        }
        getDown[getTimeSlotIndex(time)]++;
        // ------------------------veh_passenger---------------------------
        Integer nPassengers = this.vehPassengers.get(vehId);
        if (nPassengers == null) {
            log.error( "tests for `null' but exception says 'negative'???  kai, oct'10 ") ;
            throw new RuntimeException("negative passenger-No. in vehicle?");
        }
        this.vehPassengers.put(vehId, nPassengers - 1);
        if (this.vehPassengers.get(vehId).intValue() == 0) {
            this.vehPassengers.remove(vehId);
        }

        Integer passengers = this.vehPassengers.get(vehId);
        this.occupancyRecord.append("time :\t").append(time).append(" veh :\t").append(vehId).append(" has Passenger\t").append((passengers != null) ? passengers : 0).append("\n");
    }

Here is the call graph for this function:

handleEvent() [4/5]

void org.matsim.pt.counts.OccupancyAnalyzer.handleEvent

(

VehicleArrivesAtFacilityEvent

event

)

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

Definition at line 171 of file OccupancyAnalyzer.java.

References org.matsim.core.api.experimental.events.VehicleArrivesAtFacilityEvent.getVehicleId().

                                                                 {
        Id<TransitStopFacility> stopId = event.getFacilityId();
        this.vehStops.put(event.getVehicleId(), stopId);
    }

Here is the call graph for this function:

handleEvent() [5/5]

void org.matsim.pt.counts.OccupancyAnalyzer.handleEvent

(

VehicleDepartsAtFacilityEvent

event

)

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

Definition at line 177 of file OccupancyAnalyzer.java.

References org.matsim.api.core.v01.Id< T >.get(), org.matsim.api.core.v01.events.Event.getTime(), and org.matsim.pt.counts.OccupancyAnalyzer.getTimeSlotIndex().

                                                                 {
        Id<TransitStopFacility> stopId = event.getFacilityId();
        Id<Vehicle> vehId = event.getVehicleId();
        this.vehStops.remove(vehId);
        // -----------------------occupancy--------------------------------
        int[] occupancyAtStop = this.occupancies.get(stopId);

        if (occupancyAtStop == null) {
            // no previous departure from this stop, therefore no occupancy record yet.  Create this:
            occupancyAtStop = new int[this.maxSlotIndex + 1];
            this.occupancies.put(stopId, occupancyAtStop);
        }

        Integer noPassengersInVeh = this.vehPassengers.get(vehId);

        if (noPassengersInVeh != null) {
            occupancyAtStop[this.getTimeSlotIndex(event.getTime())] += noPassengersInVeh;

            this.occupancyRecord.append(event.getTime());
            this.occupancyRecord.append("\t");
            this.occupancyRecord.append(vehId);
            this.occupancyRecord.append("\t");
            this.occupancyRecord.append(stopId);
            this.occupancyRecord.append("\t");
            this.occupancyRecord.append(noPassengersInVeh);
            this.occupancyRecord.append("\n");
        }
    }

Here is the call graph for this function:

getBoardVolumesForStop()

int [] org.matsim.pt.counts.OccupancyAnalyzer.getBoardVolumesForStop

(

final Id< TransitStopFacility >

stopId

)

Parameters

stopId

Returns

Array containing the number of agents boarding at the stop stopId per time bin, starting with time bin 0 from 0 seconds to (timeBinSize-1)seconds.

Definition at line 212 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.PtCountControlerListener.notifyIterationEnds().

                                                                              {
        int[] values = this.boards.get(stopId);
        if (values == null) {
            return new int[this.maxSlotIndex + 1];
        }
        return values;
    }

getAlightVolumesForStop()

int [] org.matsim.pt.counts.OccupancyAnalyzer.getAlightVolumesForStop

(

final Id< TransitStopFacility >

stopId

)

Parameters

stopId

Returns

Array containing the number of agents alighting at the stop

stopId 

per time bin, starting with time bin 0 from 0 seconds to (timeBinSize-1)seconds.

Definition at line 226 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.PtCountControlerListener.notifyIterationEnds().

                                                                               {
        int[] values = this.alights.get(stopId);
        if (values == null) {
            return new int[this.maxSlotIndex + 1];
        }
        return values;
    }

getOccupancyVolumesForStop()

int [] org.matsim.pt.counts.OccupancyAnalyzer.getOccupancyVolumesForStop

(

final Id< TransitStopFacility >

stopId

)

Parameters

stopId

Returns

Array containing the number of passengers in bus after the transfer at the stop

stopId 

per time bin, starting with time bin 0 from 0 seconds to (timeBinSize-1)seconds.

Definition at line 240 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.PtCountControlerListener.notifyIterationEnds().

                                                                                  {
        int[] values = this.occupancies.get(stopId);
        if (values == null) {
            return new int[this.maxSlotIndex + 1];
        }
        return values;
    }

getBoardStopIds()

Set<Id<TransitStopFacility> > org.matsim.pt.counts.OccupancyAnalyzer.getBoardStopIds

(

)

Returns

Set of

Id 

s containing all stop ids, where the agents boarded, for which counting-values are available.

Definition at line 252 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.getAllStopIds().

                                                          {
        return this.boards.keySet();
    }

getAlightStopIds()

Set<Id<TransitStopFacility> > org.matsim.pt.counts.OccupancyAnalyzer.getAlightStopIds

(

)

Returns

Set of

Id 

s containing all stop ids, where the agents alit, for which counting-values are available.

Definition at line 260 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.getAllStopIds().

                                                           {
        return this.alights.keySet();
    }

getOccupancyStopIds()

Set<Id<TransitStopFacility> > org.matsim.pt.counts.OccupancyAnalyzer.getOccupancyStopIds

(

)

Definition at line 264 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.getAllStopIds().

                                                              {
        return this.occupancies.keySet();
    }

getAllStopIds()

Set<Id<TransitStopFacility> > org.matsim.pt.counts.OccupancyAnalyzer.getAllStopIds

(

)

Returns

Set of

Id 

s containing all stop ids, where the agents alit or/and boarded, for which counting-values are available.

Definition at line 272 of file OccupancyAnalyzer.java.

References org.matsim.pt.counts.OccupancyAnalyzer.getAlightStopIds(), org.matsim.pt.counts.OccupancyAnalyzer.getBoardStopIds(), and org.matsim.pt.counts.OccupancyAnalyzer.getOccupancyStopIds().

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.write().

                                                        {
        Set<Id<TransitStopFacility>> allStopIds = new TreeSet<>();
        allStopIds.addAll(getBoardStopIds());
        allStopIds.addAll(getAlightStopIds());
        allStopIds.addAll(getOccupancyStopIds());
        return allStopIds;
    }

Here is the call graph for this function:

write()

void org.matsim.pt.counts.OccupancyAnalyzer.write

(

String

filename

)

Definition at line 280 of file OccupancyAnalyzer.java.

References org.matsim.pt.counts.SimpleWriter.close(), org.matsim.pt.counts.OccupancyAnalyzer.getAllStopIds(), org.matsim.pt.counts.SimpleWriter.write(), and org.matsim.pt.counts.SimpleWriter.writeln().

Referenced by org.matsim.pt.counts.PtCountControlerListener.notifyAfterMobsim().

                                       {
        SimpleWriter writer = new SimpleWriter(filename);
        // write filehead
        writer.write("stopId\t");
        for (int i = 0; i < 24; i++) {
            writer.write("bo" + i + "-" + (i + 1) + "\t");
        }
        for (int i = 0; i < 24; i++) {
            writer.write("al" + i + "-" + (i + 1) + "\t");
        }
        for (int i = 0; i < 24; i++) {
            writer.write("oc" + i + "-" + (i + 1) + "\t");
        }
        writer.writeln();
        // write content
        for (Id<TransitStopFacility> stopId : getAllStopIds()) {
            writer.write(stopId + "\t");

            int[] board = this.boards.get(stopId);
            if (board == null){
                log.debug("stopId:\t" + stopId + "\thas null boards!");
            }
            for (int i = 0; i < 24; i++) {
                writer.write((board != null ? board[i] : 0) + "\t");
            }

            int[] alight = this.alights.get(stopId);
            if (alight == null) {
                log.debug("stopId:\t" + stopId + "\thas null alights!");
            }
            for (int i = 0; i < 24; i++) {
                writer.write((alight != null ? alight[i] : 0) + "\t");
            }

            int[] ocuppancy = this.occupancies.get(stopId);
            if (ocuppancy == null) {
                log.debug("stopId:\t" + stopId + "\tthere aren't passengers in Bus after the transfer!");
            }
            for (int i = 0; i < 24; i++) {
                writer.write((ocuppancy != null ? ocuppancy[i] : 0) + "\t");
            }
            writer.writeln();
        }
        writer.write(this.occupancyRecord.toString());
        writer.close();
    }

Here is the call graph for this function:

Member Data Documentation

log

final Logger org.matsim.pt.counts.OccupancyAnalyzer.log = LogManager.getLogger(OccupancyAnalyzer.class)

staticprivate

Definition at line 55 of file OccupancyAnalyzer.java.

timeBinSize

final int org.matsim.pt.counts.OccupancyAnalyzer.timeBinSize

private

Definition at line 57 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.OccupancyAnalyzer().

maxTime

final double org.matsim.pt.counts.OccupancyAnalyzer.maxTime

private

Definition at line 58 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.OccupancyAnalyzer().

boards

Map<Id<TransitStopFacility>, int[]> org.matsim.pt.counts.OccupancyAnalyzer.boards

private

Map< stopFacilityId,value[]>

Definition at line 60 of file OccupancyAnalyzer.java.

Referenced by org.matsim.pt.counts.OccupancyAnalyzer.setBoards().

vehStops

final Map<Id<Vehicle>, Id<TransitStopFacility> > org.matsim.pt.counts.OccupancyAnalyzer.vehStops = new HashMap<>()

private

Map< vehId,stopFacilityId>

Definition at line 64 of file OccupancyAnalyzer.java.

vehPassengers

final Map<Id<Vehicle>, Integer> org.matsim.pt.counts.OccupancyAnalyzer.vehPassengers = new HashMap<>()

private

Map<vehId,passengersNo. in Veh>

Definition at line 66 of file OccupancyAnalyzer.java.

occupancyRecord

StringBuffer org.matsim.pt.counts.OccupancyAnalyzer.occupancyRecord = new StringBuffer("time\tvehId\tStopId\tno.ofPassengersInVeh\n")

private

Definition at line 67 of file OccupancyAnalyzer.java.

transitDrivers

final Set<Id<Person> > org.matsim.pt.counts.OccupancyAnalyzer.transitDrivers = new HashSet<>()

private

Definition at line 68 of file OccupancyAnalyzer.java.

transitVehicles

final Set<Id<Vehicle> > org.matsim.pt.counts.OccupancyAnalyzer.transitVehicles = new HashSet<>()

private

Definition at line 69 of file OccupancyAnalyzer.java.

---

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

• pt/counts/OccupancyAnalyzer.java