Public Member Functions
	FacilitiesFromPopulation (final ActivityFacilities facilities)

	FacilitiesFromPopulation (Scenario scenario)

void	setFacilitiesSource (final FacilitiesSource facilitiesSource)

void	setOneFacilityPerLink (final boolean oneFacilityPerLink)

void	setIdPrefix (final String prefix)

void	setAssignLinksToFacilitiesIfMissing (final Network network)

void	setRemoveLinksAndCoordinates (final boolean doRemoval)

void	assignOpeningTimes (final ScoringConfigGroup calcScoreConfigGroup)

void	run (final Population population)

void	setAddEmptyActivityOptions (boolean addEmptyActivityOptions)

Private Member Functions
void	handleActivities (final Population population)

void	assignOpeningTimes ()

Private Attributes
final ActivityFacilities	facilities

Scenario	scenario

FacilitiesSource	facilitiesSource

String	idPrefix = ""

Network	network = null

boolean	removeLinksAndCoordinates = true

ScoringConfigGroup	scoringConfigGroup = null

boolean	addEmptyActivityOptions = false

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

Detailed Description

Generates ActivityFacilitys from the Activities in a population and assigns the activity facilities as the activity locations in the population while removing the old locations (coord and link) from the population. If an activity already has an ActivityFacility assigned, the ActivityFacility is overwritten. If an activity only has a coordinate, different behavior is possible, see setAssignLinksToFacilitiesIfMissing(Network).

Author: mrieser

Definition at line 60 of file FacilitiesFromPopulation.java.

Constructor & Destructor Documentation

◆ FacilitiesFromPopulation() [1/2]

org.matsim.facilities.FacilitiesFromPopulation.FacilitiesFromPopulation ( final ActivityFacilities facilities )

Definition at line 73 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.FacilitiesFromPopulation.facilities.

                                                                          {
         // minimalistic constructor, to configure via external setters
         this.facilities = facilities;
     }

◆ FacilitiesFromPopulation() [2/2]

org.matsim.facilities.FacilitiesFromPopulation.FacilitiesFromPopulation ( Scenario scenario )

Definition at line 78 of file FacilitiesFromPopulation.java.

References org.matsim.core.config.Config.facilities(), org.matsim.api.core.v01.Scenario.getActivityFacilities(), org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.config.groups.FacilitiesConfigGroup.getFacilitiesSource(), org.matsim.core.config.groups.FacilitiesConfigGroup.getIdPrefix(), org.matsim.api.core.v01.Scenario.getNetwork(), org.matsim.facilities.FacilitiesFromPopulation.scenario, and org.matsim.core.config.Config.scoring().

                                                          {
         // "fat" constructor, to configure via config etc.
         this(scenario.getActivityFacilities());
         FacilitiesConfigGroup facilityConfigGroup = scenario.getConfig().facilities();
         this.idPrefix = facilityConfigGroup.getIdPrefix();
 //      this.removeLinksAndCoordinates = facilityConfigGroup.isRemovingLinksAndCoordinates();
         this.removeLinksAndCoordinates = false ;
 //      this.addEmptyActivityOptions = facilityConfigGroup.isAddEmptyActivityOption();
         this.addEmptyActivityOptions = true ;
         this.facilitiesSource = facilityConfigGroup.getFacilitiesSource();
         this.network = scenario.getNetwork() ;
         this.scoringConfigGroup = scenario.getConfig().scoring() ;
         this.scenario = scenario;
     }

Here is the call graph for this function:

Member Function Documentation

◆ setFacilitiesSource()

void org.matsim.facilities.FacilitiesFromPopulation.setFacilitiesSource ( final FacilitiesSource facilitiesSource )

Definition at line 92 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.FacilitiesFromPopulation.facilitiesSource.

                                                                                {
         this.facilitiesSource = facilitiesSource;
     }

◆ setOneFacilityPerLink()

void org.matsim.facilities.FacilitiesFromPopulation.setOneFacilityPerLink ( final boolean oneFacilityPerLink )

Sets whether all activities on a link should be collected within one ActivityFacility. Default is true. If set to false, for each coordinate found in the population's activities a separate ActivityFacility will be created.

Parameters

oneFacilityPerLink

Deprecated:: – better use setFacilitiesSource(FacilitiesSource)

Definition at line 104 of file FacilitiesFromPopulation.java.

References org.matsim.core.config.groups.FacilitiesConfigGroup.FacilitiesSource.onePerActivityLinkInPlansFile, and org.matsim.core.config.groups.FacilitiesConfigGroup.FacilitiesSource.onePerActivityLocationInPlansFile.

                                                                         {
         if ( oneFacilityPerLink ) {
             this.facilitiesSource = FacilitiesSource.onePerActivityLinkInPlansFile;
         } else{
             this.facilitiesSource = FacilitiesSource.onePerActivityLocationInPlansFile;
         }
     }

◆ setIdPrefix()

void org.matsim.facilities.FacilitiesFromPopulation.setIdPrefix ( final String prefix )

Definition at line 112 of file FacilitiesFromPopulation.java.

                                                  {
         this.idPrefix = prefix;
     }

◆ setAssignLinksToFacilitiesIfMissing()

void org.matsim.facilities.FacilitiesFromPopulation.setAssignLinksToFacilitiesIfMissing ( final Network network )

In the case that a facility has no link assigned, the ActivityFacility can be assigned to the closest link. If there should be only one ActivityFacility per link (see setOneFacilityPerLink(boolean)), and if no link-assignment should be done, then a new ActivityFacility will be created at that coordinate and the facility will not be assigned to a link, essentially breaking the contract of setOneFacilityPerLink(boolean).

Parameters

network

Definition at line 125 of file FacilitiesFromPopulation.java.

References org.matsim.core.gbl.Gbl.assertNotNull(), and org.matsim.facilities.FacilitiesFromPopulation.network.

                                                                              {
         Gbl.assertNotNull( network );
         this.network = network ;
     }

Here is the call graph for this function:

◆ setRemoveLinksAndCoordinates()

void org.matsim.facilities.FacilitiesFromPopulation.setRemoveLinksAndCoordinates ( final boolean doRemoval )

If set to true (which is the default), the link and coordinate attributes are nulled in the activities, as this information is now available via the facility.

Parameters

doRemoval

Definition at line 136 of file FacilitiesFromPopulation.java.

                                                                       {
         this.removeLinksAndCoordinates = doRemoval;
     }

◆ assignOpeningTimes() [1/2]

void org.matsim.facilities.FacilitiesFromPopulation.assignOpeningTimes ( final ScoringConfigGroup calcScoreConfigGroup )

Definition at line 140 of file FacilitiesFromPopulation.java.

References org.matsim.core.gbl.Gbl.assertNotNull().

                                                                                     {
         Gbl.assertNotNull( calcScoreConfigGroup );
         this.scoringConfigGroup = calcScoreConfigGroup ;
     }

Here is the call graph for this function:

◆ run()

void org.matsim.facilities.FacilitiesFromPopulation.run ( final Population population )

Definition at line 145 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.FacilitiesFromPopulation.assignOpeningTimes(), and org.matsim.facilities.FacilitiesFromPopulation.handleActivities().

Referenced by org.matsim.core.controler.PrepareForSimImpl.run().

                                                  {
         handleActivities(population);
         if (this.scoringConfigGroup != null ) {
             if (this.addEmptyActivityOptions) {
                 this.assignOpeningTimes();
             } else{
                 log.error("Cannot assign opening times to activity facilities because switch to add empty activity option to activity facilities is set to false.");
             }
         }
     }

Here is the call graph for this function:

◆ handleActivities()

void org.matsim.facilities.FacilitiesFromPopulation.handleActivities ( final Population population )

private

Definition at line 156 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.ActivityFacilities.addActivityFacility(), org.matsim.core.gbl.Gbl.assertIf(), org.matsim.core.gbl.Gbl.assertNotNull(), org.matsim.api.core.v01.Id< T >.create(), org.matsim.facilities.ActivityFacilitiesFactory.createActivityFacility(), org.matsim.core.population.PopulationUtils.decideOnCoordForActivity(), org.matsim.api.core.v01.IdMap< T, V >.get(), org.matsim.api.core.v01.BasicLocation.getCoord(), org.matsim.api.core.v01.population.Activity.getCoord(), org.matsim.facilities.ActivityFacilities.getFacilities(), org.matsim.facilities.ActivityFacilities.getFactory(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.facilities.Facility.getLinkId(), org.matsim.api.core.v01.population.Activity.getLinkId(), org.matsim.core.network.NetworkUtils.getNearestLinkExactly(), org.matsim.api.core.v01.population.Population.getPersons(), org.matsim.core.config.groups.FacilitiesConfigGroup.FacilitiesSource.onePerActivityLinkInPlansFile, org.matsim.core.config.groups.FacilitiesConfigGroup.FacilitiesSource.onePerActivityLinkInPlansFileExceptWhenCoordinatesAreGiven, and org.matsim.api.core.v01.IdMap< T, V >.put().

Referenced by org.matsim.facilities.FacilitiesFromPopulation.run().

                                                                {
         Gbl.assertNotNull( network ) ;
 
         int idxCounter = 0;
         ActivityFacilitiesFactory factory = this.facilities.getFactory();
         IdMap<Link, ActivityFacility> facilitiesPerLinkId = new IdMap<>(Link.class);
         Map<Coord, ActivityFacility> facilitiesPerCoordinate = new HashMap<>();
 
         for (Person person : population.getPersons().values()) {
             for (Plan plan : person.getPlans()) {
                 for (PlanElement pe : plan.getPlanElements()) {
                     if (pe instanceof Activity) {
                         Activity activity = (Activity) pe;
 
                         Coord coord = activity.getCoord();
                         // (may be null, and we are not fixing it at this point)
 
                         Id<Link> linkId = activity.getLinkId();
                         // (may be null, and we are not fixing it at this point)
 
                         Gbl.assertIf( coord!=null || linkId!=null );
                         // (need one of them non-null!)
 
                         ActivityFacility facility ;
 
                         if ( linkId == null ) {
                             linkId = NetworkUtils.getNearestLinkExactly(this.network, coord).getId();
                             // yyyy we have been using the non-exact version in other parts of the project. kai, mar'19
                         }
                         if ( coord==null ) {
                             coord = PopulationUtils.decideOnCoordForActivity( activity, scenario );
                         }
 
                         Gbl.assertNotNull( linkId );
 
                         if ( this.facilitiesSource==FacilitiesSource.onePerActivityLinkInPlansFile
                                      || ( this.facilitiesSource==FacilitiesSource.onePerActivityLinkInPlansFileExceptWhenCoordinatesAreGiven && coord==null )
                         ) {
                             facility = facilitiesPerLinkId.get(linkId);
                             if (facility == null) {
                                 final Id<ActivityFacility> facilityId = Id.create( this.idPrefix + linkId.toString() , ActivityFacility.class );
                                 final ActivityFacility preExistingFacilityIfAny = this.facilities.getFacilities().get( facilityId );
                                 if ( preExistingFacilityIfAny == null ){
                                     facility = factory.createActivityFacility( facilityId , coord , linkId );
                                     facilitiesPerLinkId.put( linkId , facility );
                                     this.facilities.addActivityFacility( facility );
                                 } else {
                                     if ( Objects.equals( preExistingFacilityIfAny.getLinkId() ,
                                           linkId ) && Objects.equals( preExistingFacilityIfAny.getCoord() , coord ) ) {
                                         // do nothing; presumably, same auto-generation has been run before
                                         facility = preExistingFacilityIfAny;
                                     } else {
                                         throw new RuntimeException( "Facility with id=" + facilityId + " but different in coordinates and/or linkId already exists." ) ;
                                     }
                                 }
                                 // above code is a duplicate, but they are difficult to merge because facilitiesPerLinkId is an IdMap while facilitiesPerCoord is a normal Map.  kai, feb'20
                             }
                         } else if ( this.facilitiesSource==FacilitiesSource.onePerActivityLocationInPlansFile
                                                                   || ( this.facilitiesSource==FacilitiesSource.onePerActivityLinkInPlansFileExceptWhenCoordinatesAreGiven && coord!=null )
                         ) {
                             if (coord == null)  {
                                 throw new RuntimeException("Coordinate for the activity "+activity+" is null, cannot collect facilities per coordinate. " +
                                         "Possibly use " + FacilitiesSource.onePerActivityLinkInPlansFile + " " +
                                                          "instead and collect facilities per link.");
                             }
 
                             facility = facilitiesPerCoordinate.get(coord);
                             if (facility == null) {
                                 final Id<ActivityFacility> facilityId = Id.create( this.idPrefix + idxCounter++ , ActivityFacility.class );
                                 final ActivityFacility preExistingFacilityIfAny = this.facilities.getFacilities().get( facilityId );
                                 if ( preExistingFacilityIfAny == null ){
                                     facility = factory.createActivityFacility( facilityId , coord , linkId );
                                     facilitiesPerCoordinate.put( coord , facility );
                                     this.facilities.addActivityFacility( facility );
                                 } else {
                                     if ( Objects.equals( preExistingFacilityIfAny.getLinkId() , linkId ) && Objects.equals( preExistingFacilityIfAny.getCoord() , coord ) ) {
                                         // do nothing; presumably, same auto-generation has been run before
                                         facility = preExistingFacilityIfAny;
                                     } else {
                                         throw new RuntimeException( "Facility with id=" + facilityId + " but different in coordinates and/or linkId already exists." ) ;
                                     }
                                 }
                                 // above code is a duplicate, but they are difficult to merge because facilitiesPerLinkId is an IdMap while facilitiesPerCoord is a normal Map.  kai, feb'20
                             }
                         } else {
                             throw new RuntimeException( "should never get to this location; either class/method used with invalid" +
                                                     " setting of facilitiesSource, or something there is " +
                                                     "something that was not understood while implementing " +
                                                     "this." );
                         }
 
                         if (this.addEmptyActivityOptions) {
                             String actType = activity.getType();
                             ActivityOption option = facility.getActivityOptions().get(actType);
                             if (option == null) {
                                 option = factory.createActivityOption(actType);
                                 facility.addActivityOption(option);
                             }
                         }
 
                         activity.setFacilityId(facility.getId());
                         if (this.removeLinksAndCoordinates) {
                             activity.setLinkId(null);
                             activity.setCoord(null);
                         }
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ assignOpeningTimes() [2/2]

void org.matsim.facilities.FacilitiesFromPopulation.assignOpeningTimes ( )

private

Definition at line 267 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.OpeningTimeImpl.createFromOptionalTimes(), org.matsim.core.config.groups.ScoringConfigGroup.getActivityParams(), org.matsim.core.config.groups.ScoringConfigGroup.ActivityParams.getClosingTime(), org.matsim.facilities.ActivityFacilities.getFacilities(), and org.matsim.core.config.groups.ScoringConfigGroup.ActivityParams.getOpeningTime().

Referenced by org.matsim.facilities.FacilitiesFromPopulation.run().

                                       {
         Set<String> missingActTypes = new HashSet<>();
         for (ActivityFacility af : this.facilities.getFacilities().values()) {
             for (ActivityOption ao : af.getActivityOptions().values()) {
                 String actType = ao.getType();
                 ActivityParams params = this.scoringConfigGroup.getActivityParams(actType);
                 if (params == null) {
                     if (missingActTypes.add(actType)) {
                         log.error("No information for activity type " + actType + " found in given configuration.");
                     }
                 } else {
                     ao.addOpeningTime(OpeningTimeImpl.createFromOptionalTimes(params.getOpeningTime(),
                             params.getClosingTime()));
                 }
             }
         }
     }

Here is the call graph for this function:

◆ setAddEmptyActivityOptions()

void org.matsim.facilities.FacilitiesFromPopulation.setAddEmptyActivityOptions ( boolean addEmptyActivityOptions )

Definition at line 285 of file FacilitiesFromPopulation.java.

References org.matsim.facilities.FacilitiesFromPopulation.addEmptyActivityOptions.

                                                                             {
         this.addEmptyActivityOptions = addEmptyActivityOptions;
     }