Classes
interface	CustomLegsWriterExtension

interface	CustomTimeWriter

interface	CustomTripsWriterExtension

class	DefaultTimeWriter

class	NoLegsWriterExtension

class	NoTripWriterExtension

class	SecondsFromMidnightTimeWriter

Public Member Functions
	TripsAndLegsWriter (Scenario scenario, CustomTripsWriterExtension tripsWriterExtension, CustomLegsWriterExtension legWriterExtension, AnalysisMainModeIdentifier mainModeIdentifier, CustomTimeWriter customTimeWriter)

void	write (IdMap< Person, Plan > experiencedPlans, String tripsFilename, String legsFilename)

Static Public Attributes
static final String []	TRIPSHEADER_BASE

static final String []	LEGSHEADER_BASE

Private Member Functions
char	getDefaultDelimiter ()

Tuple< Iterable<?>, Iterable<?> >	getPlanCSVRecords (Plan experiencedPlan, Id< Person > personId)

StringBuilder	getTripErrorMessage (List< String > tripRecord)

List< String >	getLegRecord (Leg leg, String personId, String tripId, Activity previousAct, Activity nextAct, TripStructureUtils.Trip trip)

String	getLegErrorMessage (List< String > record)

Coord	getCoordFromActivity (Activity activity)

Coord	getCoordFromLink (Id< Link > linkId)

Private Attributes
final String []	TRIPSHEADER

final String []	LEGSHEADER

final CustomTripsWriterExtension	tripsWriterExtension

final Scenario	scenario

final CustomLegsWriterExtension	legsWriterExtension

final AnalysisMainModeIdentifier	mainModeIdentifier

final CustomTimeWriter	customTimeWriter

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

Detailed Description

Author: jbischoff / SBB

Definition at line 60 of file TripsAndLegsWriter.java.

Constructor & Destructor Documentation

◆ TripsAndLegsWriter()

org.matsim.analysis.TripsAndLegsWriter.TripsAndLegsWriter	(	Scenario	scenario,
		CustomTripsWriterExtension	tripsWriterExtension,
		CustomLegsWriterExtension	legWriterExtension,
		AnalysisMainModeIdentifier	mainModeIdentifier,
		CustomTimeWriter	customTimeWriter
	)

Definition at line 81 of file TripsAndLegsWriter.java.

References org.matsim.analysis.TripsAndLegsWriter.customTimeWriter, org.matsim.analysis.TripsAndLegsWriter.CustomLegsWriterExtension.getAdditionalLegHeader(), org.matsim.analysis.TripsAndLegsWriter.CustomTripsWriterExtension.getAdditionalTripHeader(), org.matsim.analysis.TripsAndLegsWriter.mainModeIdentifier, org.matsim.analysis.TripsAndLegsWriter.scenario, and org.matsim.analysis.TripsAndLegsWriter.tripsWriterExtension.

                                                                                                                 {
         this.scenario = scenario;
         this.tripsWriterExtension = tripsWriterExtension;
         this.legsWriterExtension = legWriterExtension;
         this.mainModeIdentifier = mainModeIdentifier;
         this.customTimeWriter = customTimeWriter;
 
         TRIPSHEADER = ArrayUtils.addAll(TRIPSHEADER_BASE, tripsWriterExtension.getAdditionalTripHeader());
         LEGSHEADER = ArrayUtils.addAll(LEGSHEADER_BASE, legWriterExtension.getAdditionalLegHeader());
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultDelimiter()

char org.matsim.analysis.TripsAndLegsWriter.getDefaultDelimiter ( )

private

Definition at line 93 of file TripsAndLegsWriter.java.

References org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.config.groups.GlobalConfigGroup.getDefaultDelimiter(), and org.matsim.core.config.Config.global().

Referenced by org.matsim.analysis.TripsAndLegsWriter.write().

                                        {
         return scenario.getConfig().global().getDefaultDelimiter().charAt(0);
     }

Here is the call graph for this function:

◆ write()

void org.matsim.analysis.TripsAndLegsWriter.write	(	IdMap< Person, Plan >	experiencedPlans,
		String	tripsFilename,
		String	legsFilename
	)

Definition at line 97 of file TripsAndLegsWriter.java.

References org.matsim.api.core.v01.IdMap< T, V >.entrySet(), org.matsim.core.utils.io.IOUtils.getBufferedWriter(), org.matsim.analysis.TripsAndLegsWriter.getDefaultDelimiter(), org.matsim.core.utils.collections.Tuple< A, B >.getFirst(), org.matsim.analysis.TripsAndLegsWriter.getPlanCSVRecords(), and org.matsim.core.utils.collections.Tuple< A, B >.getSecond().

                                                                                                        {
         try (CSVPrinter tripsCSVprinter = new CSVPrinter(IOUtils.getBufferedWriter(tripsFilename),
             CSVFormat.Builder.create().setDelimiter(getDefaultDelimiter()).setHeader(TRIPSHEADER).build());
              CSVPrinter legsCSVprinter = new CSVPrinter(IOUtils.getBufferedWriter(legsFilename),
                  CSVFormat.Builder.create().setDelimiter(getDefaultDelimiter()).setHeader(LEGSHEADER).build())
         ) {
             for (Map.Entry<Id<Person>, Plan> entry : experiencedPlans.entrySet()) {
                 Tuple<Iterable<?>, Iterable<?>> tripsAndLegRecords = getPlanCSVRecords(entry.getValue(), entry.getKey());
                 tripsCSVprinter.printRecords(tripsAndLegRecords.getFirst());
                 legsCSVprinter.printRecords(tripsAndLegRecords.getSecond());
             }
         } catch (IOException e) {
             e.printStackTrace();
         }
     }

Here is the call graph for this function:

◆ getPlanCSVRecords()

Tuple<Iterable<?>, Iterable<?> > org.matsim.analysis.TripsAndLegsWriter.getPlanCSVRecords	(	Plan	experiencedPlan,
		Id< Person >	personId
	)

private

Definition at line 113 of file TripsAndLegsWriter.java.

References org.matsim.core.utils.geometry.CoordUtils.calcEuclideanDistance(), org.matsim.core.scoring.EventsToLegs.ENTER_VEHICLE_TIME_ATTRIBUTE_NAME, org.matsim.analysis.TripsAndLegsWriter.CustomTripsWriterExtension.getAdditionalTripColumns(), org.matsim.analysis.TripsAndLegsWriter.getCoordFromActivity(), org.matsim.analysis.TripsAndLegsWriter.getTripErrorMessage(), org.matsim.core.router.TripStructureUtils.getTrips(), org.matsim.api.core.v01.Coord.getX(), org.matsim.api.core.v01.Coord.getY(), org.matsim.core.router.MainModeIdentifier.identifyMainMode(), org.matsim.core.utils.collections.Tuple< A, B >.toString(), and org.matsim.analysis.TripsAndLegsWriter.CustomTimeWriter.writeTime().

Referenced by org.matsim.analysis.TripsAndLegsWriter.write().

                                                                                                          {
         List<List<String>> tripRecords = new ArrayList<>();
         List<List<String>> legRecords = new ArrayList<>();
         Tuple<Iterable<?>, Iterable<?>> record = new Tuple<>(tripRecords, legRecords);
         List<TripStructureUtils.Trip> trips = TripStructureUtils.getTrips(experiencedPlan);
 
         for (int i = 0; i < trips.size(); i++) {
             TripStructureUtils.Trip trip = trips.get(i);
             List<String> tripRecord = new ArrayList<>();
             tripRecords.add(tripRecord);
             tripRecord.add(personId.toString());
             final String tripNo = Integer.toString(i + 1);
             tripRecord.add(tripNo); // trip number, numbered starting with 0
             String tripId = personId + "_" + tripNo;
             tripRecord.add(tripId);
             double distance = 0.0;
             double departureTime = trip.getOriginActivity().getEndTime().orElse(0);
             double travelTime = trip.getDestinationActivity().getStartTime().orElse(0) - departureTime;
             //experienced plans have a start time
 
             double totalWaitingTime = 0.0;
             double currentLongestShareDistance = Double.MIN_VALUE;
             String currentModeWithLongestShare = "";
             List<String> modes = new ArrayList<>();
             String lastActivityType = trip.getOriginActivity().getType();
             String nextActivityType = trip.getDestinationActivity().getType();
             Id<ActivityFacility> fromFacilityId = trip.getOriginActivity().getFacilityId();
             Id<ActivityFacility> toFacilityId = trip.getDestinationActivity().getFacilityId();
             Id<Link> fromLinkId = trip.getOriginActivity().getLinkId();
             Id<Link> toLinkId = trip.getDestinationActivity().getLinkId();
             Coord fromCoord = getCoordFromActivity(trip.getOriginActivity());
             Coord toCoord = getCoordFromActivity(trip.getDestinationActivity());
             int euclideanDistance = (int) CoordUtils.calcEuclideanDistance(fromCoord, toCoord);
             String firstPtBoardingStop = null;
             String lastPtEgressStop = null;
 
             String mainMode = "";
             if (mainModeIdentifier != null) {
                 try {
                     mainMode = mainModeIdentifier.identifyMainMode(trip.getTripElements());
                     if (mainMode == null)
                         mainMode = "";
                 } catch (Exception e) {
                     // leave field empty
                 }
             }
 
             for (Leg leg : trip.getLegsOnly()) {
                 modes.add(leg.getMode());
                 final double legDist = leg.getRoute().getDistance();
                 distance += legDist;
                 Double boardingTime = (Double) leg.getAttributes().getAttribute(EventsToLegs.ENTER_VEHICLE_TIME_ATTRIBUTE_NAME);
                 if (boardingTime != null) {
                     double waitingTime = boardingTime - leg.getDepartureTime().seconds();
                     totalWaitingTime += waitingTime;
                 }
                 if (StringUtils.isBlank(currentModeWithLongestShare) || legDist > currentLongestShareDistance) {
                     currentLongestShareDistance = legDist;
                     currentModeWithLongestShare = leg.getMode();
 
                 }
                 if (leg.getRoute() instanceof TransitPassengerRoute route) {
                     firstPtBoardingStop = firstPtBoardingStop != null ? firstPtBoardingStop : route.getAccessStopId().toString();
                     lastPtEgressStop = route.getEgressStopId().toString();
                 }
 
             }
 
             tripRecord.add(customTimeWriter.writeTime(departureTime));
             tripRecord.add(customTimeWriter.writeTime(travelTime));
             tripRecord.add(customTimeWriter.writeTime(totalWaitingTime));
             tripRecord.add(Integer.toString((int) Math.round(distance)));
             tripRecord.add(Integer.toString(euclideanDistance));
             tripRecord.add(mainMode);
             tripRecord.add(currentModeWithLongestShare);
             tripRecord.add(modes.stream().collect(Collectors.joining("-")));
             tripRecord.add(lastActivityType);
             tripRecord.add(nextActivityType);
             tripRecord.add(String.valueOf(fromFacilityId));
             tripRecord.add(String.valueOf(fromLinkId));
             tripRecord.add(Double.toString(fromCoord.getX()));
             tripRecord.add(Double.toString(fromCoord.getY()));
 
             tripRecord.add(String.valueOf(toFacilityId));
             tripRecord.add(String.valueOf(toLinkId));
             tripRecord.add(Double.toString(toCoord.getX()));
             tripRecord.add(Double.toString(toCoord.getY()));
             tripRecord.add(firstPtBoardingStop != null ? firstPtBoardingStop : "");
             tripRecord.add(lastPtEgressStop != null ? lastPtEgressStop : "");
             tripRecord.addAll(tripsWriterExtension.getAdditionalTripColumns(personId, trip));
 
             if (TRIPSHEADER.length != tripRecord.size()) {
                 // put the whole error message also into the RuntimeException, so maven shows it on the command line output (log messages are shown incompletely)
                 String errorMessage = getTripErrorMessage(tripRecord).toString();
                 log.error(errorMessage);
                 throw new RuntimeException(errorMessage);
             }
 
             Activity prevAct = null;
             Leg prevLeg = null;
             List<PlanElement> allElements = new ArrayList<>();
             allElements.add(trip.getOriginActivity());
             allElements.addAll(trip.getTripElements());
             allElements.add(trip.getDestinationActivity());
             for (PlanElement pe : allElements) {
                 if (pe instanceof Activity currentAct) {
                     if (prevLeg != null) {
                         List<String> legRecord = getLegRecord(prevLeg, personId.toString(), tripId, prevAct, currentAct, trip);
                         legRecords.add(legRecord);
                     }
                     prevAct = currentAct;
 
                 } else if (pe instanceof Leg) {
                     prevLeg = (Leg) pe;
                 }
             }
         }
 
         return record;
     }

Here is the call graph for this function:

◆ getTripErrorMessage()

StringBuilder org.matsim.analysis.TripsAndLegsWriter.getTripErrorMessage ( List< String > tripRecord )

private

Definition at line 234 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.getPlanCSVRecords().

                                                                        {
         StringBuilder str = new StringBuilder();
         str.append("Custom CSV Trip Writer Extension does not provide an identical number of additional values and additional columns. Number of columns is ")
             .append(TRIPSHEADER.length).append(", and number of values is ").append(tripRecord.size())
             .append(".\n")
             .append("TripsWriterExtension class was: ").append(tripsWriterExtension.getClass())
             .append(". Column name to value pairs supplied were:\n");
         for (int j = 0; j < Math.max(TRIPSHEADER.length, tripRecord.size()); j++) {
             String columnNameJ;
             try {
                 columnNameJ = TRIPSHEADER[j];
             } catch (ArrayIndexOutOfBoundsException e) {
                 columnNameJ = "!COLUMN MISSING!";
             }
             String tripRecordJ;
             try {
                 tripRecordJ = tripRecord.get(j);
             } catch (IndexOutOfBoundsException e) {
                 tripRecordJ = "!VALUE MISSING!";
             }
             str.append(j + ": " + columnNameJ + ": " + tripRecordJ + "\n");
         }
         return str;
     }

◆ getLegRecord()

List<String> org.matsim.analysis.TripsAndLegsWriter.getLegRecord	(	Leg	leg,
		String	personId,
		String	tripId,
		Activity	previousAct,
		Activity	nextAct,
		TripStructureUtils.Trip	trip
	)

private

Definition at line 259 of file TripsAndLegsWriter.java.

                                                                                                                                                      {
         List<String> record = new ArrayList<>();
         record.add(personId);
         record.add(tripId);
         record.add(customTimeWriter.writeTime(leg.getDepartureTime().seconds()));
         record.add(customTimeWriter.writeTime(leg.getTravelTime().seconds()));
         Double boardingTime = (Double) leg.getAttributes().getAttribute(EventsToLegs.ENTER_VEHICLE_TIME_ATTRIBUTE_NAME);
         Id<Vehicle> vehicleId = (Id<Vehicle>) leg.getAttributes().getAttribute(EventsToLegs.VEHICLE_ID_ATTRIBUTE_NAME);
         double waitingTime = 0.;
         if (boardingTime != null) {
             waitingTime = boardingTime - leg.getDepartureTime().seconds();
         }
         record.add(customTimeWriter.writeTime(waitingTime));
         record.add(Integer.toString((int) leg.getRoute().getDistance()));
         record.add(leg.getMode());
 
         if (vehicleId != null && scenario.getVehicles().getVehicles().containsKey(vehicleId)) {
             VehicleType type = scenario.getVehicles().getVehicles().get(vehicleId).getType();
             record.add(type.hasNetworkMode() ? type.getNetworkMode() : "");
         } else {
             record.add("");
         }
 
         record.add(leg.getRoute().getStartLinkId().toString());
         Coord startCoord = getCoordFromActivity(previousAct);
         Coord endCoord = getCoordFromActivity(nextAct);
         record.add(Double.toString(startCoord.getX()));
         record.add(Double.toString(startCoord.getY()));
         record.add(leg.getRoute().getEndLinkId().toString());
         record.add(Double.toString(endCoord.getX()));
         record.add(Double.toString(endCoord.getY()));
         String transitLine = "";
         String transitRoute = "";
         String ptAccessStop = "";
         String ptEgressStop = "";
         if (leg.getRoute() instanceof TransitPassengerRoute route) {
             transitLine = route.getLineId().toString();
             transitRoute = route.getRouteId().toString();
             ptAccessStop = route.getAccessStopId().toString();
             ptEgressStop = route.getEgressStopId().toString();
         }
         record.add(ptAccessStop);
         record.add(ptEgressStop);
         record.add(transitLine);
         record.add(transitRoute);
         record.add(vehicleId != null ? vehicleId.toString() : "");
 
         record.addAll(legsWriterExtension.getAdditionalLegColumns(trip, leg));
 
         if (LEGSHEADER.length != record.size()) {
             // put the whole error message also into the RuntimeException, so maven shows it on the command line output (log messages are shown incompletely)
             String errorMessage = getLegErrorMessage(record);
             log.error(errorMessage);
             throw new RuntimeException(errorMessage);
         }
 
         return record;
     }

Here is the call graph for this function:

◆ getLegErrorMessage()

String org.matsim.analysis.TripsAndLegsWriter.getLegErrorMessage ( List< String > record )

private

Definition at line 318 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.getLegRecord().

                                                            {
         StringBuilder str = new StringBuilder();
         str.append("Custom CSV Leg Writer Extension does not provide an identical number of additional values and additional columns. Number of columns is ")
             .append(LEGSHEADER.length)
             .append(", and number of values is ")
             .append(record.size())
             .append(".\n")
             .append("LegsWriterExtension class was: ")
             .append(legsWriterExtension.getClass())
             .append(". Column name to value pairs supplied were:\n");
         for (int j = 0; j < Math.max(LEGSHEADER.length, record.size()); j++) {
             String columnNameJ;
             try {
                 columnNameJ = LEGSHEADER[j];
             } catch (ArrayIndexOutOfBoundsException e) {
                 columnNameJ = "!COLUMN MISSING!";
             }
             String recordJ;
             try {
                 recordJ = record.get(j);
             } catch (IndexOutOfBoundsException e) {
                 recordJ = "!VALUE MISSING!";
             }
             str.append(j).append(": ").append(columnNameJ).append(": ").append(recordJ).append("\n");
         }
         return str.toString();
     }

◆ getCoordFromActivity()

Coord org.matsim.analysis.TripsAndLegsWriter.getCoordFromActivity ( Activity activity )

private

Definition at line 346 of file TripsAndLegsWriter.java.

References org.matsim.api.core.v01.Scenario.getActivityFacilities(), org.matsim.api.core.v01.population.Activity.getCoord(), org.matsim.analysis.TripsAndLegsWriter.getCoordFromLink(), org.matsim.facilities.ActivityFacilities.getFacilities(), org.matsim.api.core.v01.population.Activity.getFacilityId(), and org.matsim.api.core.v01.population.Activity.getLinkId().

Referenced by org.matsim.analysis.TripsAndLegsWriter.getLegRecord(), and org.matsim.analysis.TripsAndLegsWriter.getPlanCSVRecords().

                                                           {
         if (activity.getCoord() != null) {
             return activity.getCoord();
         } else if (activity.getFacilityId() != null && scenario.getActivityFacilities().getFacilities().containsKey(activity.getFacilityId())) {
             Coord coord = scenario.getActivityFacilities().getFacilities().get(activity.getFacilityId()).getCoord();
             return coord != null ? coord : getCoordFromLink(activity.getLinkId());
         } else return getCoordFromLink(activity.getLinkId());
     }

Here is the call graph for this function:

◆ getCoordFromLink()

Coord org.matsim.analysis.TripsAndLegsWriter.getCoordFromLink ( Id< Link > linkId )

private

Definition at line 356 of file TripsAndLegsWriter.java.

References org.matsim.api.core.v01.network.Network.getLinks(), and org.matsim.api.core.v01.Scenario.getNetwork().

Referenced by org.matsim.analysis.TripsAndLegsWriter.getCoordFromActivity().

                                                     {
         return scenario.getNetwork().getLinks().get(linkId).getToNode().getCoord();
     }

Here is the call graph for this function:

Member Data Documentation

◆ TRIPSHEADER_BASE

final String [] org.matsim.analysis.TripsAndLegsWriter.TRIPSHEADER_BASE

static

Initial value:

= {"person", "trip_number", "trip_id",
        "dep_time", "trav_time", "wait_time", "traveled_distance", "euclidean_distance",
        "main_mode", "longest_distance_mode", "modes", "start_activity_type",
        "end_activity_type", "start_facility_id", "start_link",
        "start_x", "start_y", "end_facility_id",
        "end_link", "end_x", "end_y", "first_pt_boarding_stop", "last_pt_egress_stop"}

Definition at line 61 of file TripsAndLegsWriter.java.

◆ LEGSHEADER_BASE

final String [] org.matsim.analysis.TripsAndLegsWriter.LEGSHEADER_BASE

static

Initial value:

= {"person", "trip_id",
        "dep_time", "trav_time", "wait_time", "distance", "mode", "network_mode", "start_link",
        "start_x", "start_y", "end_link", "end_x", "end_y", "access_stop_id", "egress_stop_id", "transit_line", "transit_route", "vehicle_id"}

Definition at line 68 of file TripsAndLegsWriter.java.

◆ log

final Logger org.matsim.analysis.TripsAndLegsWriter.log = LogManager.getLogger(TripsAndLegsWriter.class)

staticprivate

Definition at line 71 of file TripsAndLegsWriter.java.

◆ TRIPSHEADER

final String [] org.matsim.analysis.TripsAndLegsWriter.TRIPSHEADER

private

Definition at line 72 of file TripsAndLegsWriter.java.

◆ LEGSHEADER

final String [] org.matsim.analysis.TripsAndLegsWriter.LEGSHEADER

private

Definition at line 73 of file TripsAndLegsWriter.java.

◆ tripsWriterExtension

final CustomTripsWriterExtension org.matsim.analysis.TripsAndLegsWriter.tripsWriterExtension

private

Definition at line 74 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.TripsAndLegsWriter().

◆ scenario

final Scenario org.matsim.analysis.TripsAndLegsWriter.scenario

private

Definition at line 75 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.TripsAndLegsWriter().

◆ legsWriterExtension

final CustomLegsWriterExtension org.matsim.analysis.TripsAndLegsWriter.legsWriterExtension

private

Definition at line 76 of file TripsAndLegsWriter.java.

◆ mainModeIdentifier

final AnalysisMainModeIdentifier org.matsim.analysis.TripsAndLegsWriter.mainModeIdentifier

private

Definition at line 77 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.TripsAndLegsWriter().

◆ customTimeWriter

final CustomTimeWriter org.matsim.analysis.TripsAndLegsWriter.customTimeWriter

private

Definition at line 78 of file TripsAndLegsWriter.java.

Referenced by org.matsim.analysis.TripsAndLegsWriter.TripsAndLegsWriter().

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

analysis/TripsAndLegsWriter.java

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TripsAndLegsWriter()

Member Function Documentation

◆ getDefaultDelimiter()

◆ write()

◆ getPlanCSVRecords()

◆ getTripErrorMessage()

◆ getLegRecord()

◆ getLegErrorMessage()

◆ getCoordFromActivity()

◆ getCoordFromLink()

Member Data Documentation

◆ TRIPSHEADER_BASE

◆ LEGSHEADER_BASE

◆ log

◆ TRIPSHEADER

◆ LEGSHEADER

◆ tripsWriterExtension

◆ scenario

◆ legsWriterExtension

◆ mainModeIdentifier

◆ customTimeWriter