org.matsim.households.HouseholdsAlgorithmRunner Class Reference

Public Member Functions
final void	runAlgorithms (Households hh)
void	runAlgorithms (Household h)
final void	clearAlgorithms ()
boolean	removeAlgorithm (final HouseholdAlgorithm algorithm)
final void	addAlgorithm (final HouseholdAlgorithm algorithm)

Private Attributes
final List< HouseholdAlgorithm >	householdAlgorithms = new ArrayList<HouseholdAlgorithm>()

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

Detailed Description

Author

jjoubert

dgrether

Definition at line 36 of file HouseholdsAlgorithmRunner.java.

Member Function Documentation

runAlgorithms() [1/2]

final void org.matsim.households.HouseholdsAlgorithmRunner.runAlgorithms

(

Households

hh

)

Run all the algorithms added to the container.

Definition at line 45 of file HouseholdsAlgorithmRunner.java.

References org.matsim.households.Households.getHouseholds(), org.matsim.core.utils.misc.Counter.incCounter(), org.matsim.core.utils.misc.Counter.printCounter(), and org.matsim.households.algorithms.HouseholdAlgorithm.run().

Referenced by org.matsim.households.HouseholdsStreamingReaderV10.endTag().

                                                  {
            for(int i = 0; i < this.householdAlgorithms.size(); i++){
                HouseholdAlgorithm algorithm = this.householdAlgorithms.get(i);
                log.info("Running algorithm " + algorithm.getClass().getName());
                Counter c = new Counter ("  household # ");
                for(Household household : hh.getHouseholds().values()){
                    algorithm.run(household);
                    c.incCounter();
                }
                c.printCounter();
                log.info("Done running algorithm.");
            }
    }

Here is the call graph for this function:

runAlgorithms() [2/2]

void org.matsim.households.HouseholdsAlgorithmRunner.runAlgorithms

(

Household

h

)

Definition at line 59 of file HouseholdsAlgorithmRunner.java.

References org.matsim.api.core.v01.Identifiable< T >.getId().

                                          {
        for(HouseholdAlgorithm algorithm : this.householdAlgorithms){
            log.info("Running algorithm " + algorithm.getClass().getName() + " on household " + h.getId());
            algorithm.run(h);
        }       
    }

Here is the call graph for this function:

clearAlgorithms()

final void org.matsim.households.HouseholdsAlgorithmRunner.clearAlgorithms

(

)

Removes all the algorithms from the Households container.

Definition at line 70 of file HouseholdsAlgorithmRunner.java.

                                       {
        this.householdAlgorithms.clear();
    }

removeAlgorithm()

boolean org.matsim.households.HouseholdsAlgorithmRunner.removeAlgorithm

(

final HouseholdAlgorithm

algorithm

)

Removes the first instance found of the algorithm from the list. It is possible that the same algorithm can appear multiple times in the list.

Parameters

algorithm

Returns

Definition at line 80 of file HouseholdsAlgorithmRunner.java.

                                                                      {
        return this.householdAlgorithms.remove(algorithm);
    }

addAlgorithm()

final void org.matsim.households.HouseholdsAlgorithmRunner.addAlgorithm

(

final HouseholdAlgorithm

algorithm

)

Add the algorithm to the container. Algorithms will be executed in the same sequence in which they are added.

Parameters

algorithm

Definition at line 90 of file HouseholdsAlgorithmRunner.java.

                                                                      {
        this.householdAlgorithms.add(algorithm);
    }

Member Data Documentation

log

final Logger org.matsim.households.HouseholdsAlgorithmRunner.log = LogManager.getLogger(HouseholdsAlgorithmRunner.class)

staticprivate

Definition at line 38 of file HouseholdsAlgorithmRunner.java.

householdAlgorithms

final List<HouseholdAlgorithm> org.matsim.households.HouseholdsAlgorithmRunner.householdAlgorithms = new ArrayList<HouseholdAlgorithm>()

private

Definition at line 40 of file HouseholdsAlgorithmRunner.java.

---

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

• households/HouseholdsAlgorithmRunner.java