org.matsim.analysis.CalcAverageTripLength Class Reference

Inheritance diagram for org.matsim.analysis.CalcAverageTripLength:

Public Member Functions
	CalcAverageTripLength (final Network network)
void	run (final Person person)
void	run (final Plan plan)
double	getAverageTripLength ()
final void	run (final Population plans)

Private Attributes
double	sumLength = 0.0
int	cntTrips = 0
final Network	network

Detailed Description

Calculates the average trip length of all routes in a plan. The trip length is the sum of the length of all links, including the route's end link, but not including the route's start link.

This class works only for NetworkRoutes and will likely fail for legs with other types of Routes.

Author

mrieser

Definition at line 44 of file CalcAverageTripLength.java.

Constructor & Destructor Documentation

CalcAverageTripLength()

org.matsim.analysis.CalcAverageTripLength.CalcAverageTripLength

(

final Network

network

)

Definition at line 50 of file CalcAverageTripLength.java.

References org.matsim.analysis.CalcAverageTripLength.network.

                                                        {
        this.network = network;
    }

Member Function Documentation

run() [1/3]

void org.matsim.analysis.CalcAverageTripLength.run

(

final Person

person

)

Implements org.matsim.core.population.algorithms.PersonAlgorithm.

Definition at line 55 of file CalcAverageTripLength.java.

References org.matsim.api.core.v01.population.HasPlansAndId< T extends BasicPlan, I >.getSelectedPlan().

                                         {
        this.run(person.getSelectedPlan());
    }

Here is the call graph for this function:

run() [2/3]

void org.matsim.analysis.CalcAverageTripLength.run

(

final Plan

plan

)

Implements org.matsim.core.population.algorithms.PlanAlgorithm.

Definition at line 60 of file CalcAverageTripLength.java.

References org.matsim.core.population.routes.RouteUtils.calcDistanceExcludingStartEndLink(), org.matsim.api.core.v01.population.Route.getEndLinkId(), org.matsim.api.core.v01.network.Network.getLinks(), org.matsim.api.core.v01.population.Plan.getPlanElements(), org.matsim.api.core.v01.population.Leg.getRoute(), and org.matsim.api.core.v01.population.Route.getStartLinkId().

                                     {
        for (PlanElement pe : plan.getPlanElements()) {
            if (pe instanceof Leg) {
                Leg leg = (Leg) pe;
                Route route = leg.getRoute();
                if (route != null) {
                    // does not work for Routes which are not a NetworkRoute, e.g. DrtRoute
                    double dist = RouteUtils.calcDistanceExcludingStartEndLink((NetworkRoute) route, this.network);
                    if (route.getEndLinkId() != null && route.getStartLinkId() != route.getEndLinkId()) {
                        dist += this.network.getLinks().get(route.getEndLinkId()).getLength();
                    }
                    this.sumLength += dist;
                    this.cntTrips++;
                }
            }
        }
    }

Here is the call graph for this function:

getAverageTripLength()

double org.matsim.analysis.CalcAverageTripLength.getAverageTripLength

(

)

Definition at line 78 of file CalcAverageTripLength.java.

                                         {
        if (this.cntTrips == 0) {
            return 0;
        }
        return (this.sumLength / this.cntTrips);
    }

run() [3/3]

final void org.matsim.core.population.algorithms.AbstractPersonAlgorithm.run ( final Population  plans )

inherited

Definition at line 34 of file AbstractPersonAlgorithm.java.

References org.matsim.api.core.v01.population.Population.getPersons(), org.matsim.core.utils.misc.Counter.incCounter(), and org.matsim.core.utils.misc.Counter.printCounter().

                                                  {
        log.info("running " + this.getClass().getName() + " algorithm...");
        Counter counter = new Counter(" person # ");

        for (Person p : plans.getPersons().values()) {
            counter.incCounter();
            this.run(p);
        }
        counter.printCounter();
        log.info("done running algorithm.");
    }

Here is the call graph for this function:

Member Data Documentation

sumLength

double org.matsim.analysis.CalcAverageTripLength.sumLength = 0.0

private

Definition at line 46 of file CalcAverageTripLength.java.

cntTrips

int org.matsim.analysis.CalcAverageTripLength.cntTrips = 0

private

Definition at line 47 of file CalcAverageTripLength.java.

network

final Network org.matsim.analysis.CalcAverageTripLength.network

private

Definition at line 48 of file CalcAverageTripLength.java.

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

---

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

• analysis/CalcAverageTripLength.java