org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap Class Reference

Inheritance diagram for org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap:

Public Member Functions
	ActivityReplanningMap (MobsimDataProvider mobsimDataProvider, EventsManager eventsManager)
void	notifyMobsimInitialized (MobsimInitializedEvent e)
void	notifyMobsimAfterSimStep (MobsimAfterSimStepEvent e)
void	handleEvent (ActivityStartEvent event)
void	handleEvent (ActivityEndEvent event)
void	handleEvent (PersonStuckEvent event)
void	handleEvent (ReplanningEvent event)
Set< Id< Person > >	getActivityPerformingAgents ()
Collection< MobsimAgent >	getActivityEndingAgents (double time)
void	reset (int iteration)

Private Member Functions
Map< Id< Person >, MobsimAgent >	getMapForTimeBin (int bin)

Private Attributes
final MobsimDataProvider	mobsimDataProvider
final Map< Id< Person >, MobsimAgent >	startingAgents
final Map< Id< Person >, Double >	activityEndTimes
final Map< Integer, Map< Id< Person >, MobsimAgent > >	activityPerformingAgents

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

Detailed Description

This class tracks agents and their activity end times. It can be used to identify those agents which are going to end their activities in the current time step. Doing so allows one to e.g. extend their activities. Moreover, it can return a set containing all agents currently performing activites.

Definition at line 60 of file ActivityReplanningMap.java.

Constructor & Destructor Documentation

ActivityReplanningMap()

org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.ActivityReplanningMap	(	MobsimDataProvider	mobsimDataProvider,
		EventsManager	eventsManager
	)

Definition at line 97 of file ActivityReplanningMap.java.

References org.matsim.core.api.experimental.events.EventsManager.addHandler(), and org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.mobsimDataProvider.

                                                                                                     {
        eventsManager.addHandler(this);
        log.info("Note that the ActivityReplanningMap has to be registered as an EventHandler and a SimulationListener!");

        this.mobsimDataProvider = mobsimDataProvider;

        this.startingAgents = new HashMap<>();
        this.activityEndTimes = new HashMap<>();

        this.activityPerformingAgents = new ConcurrentHashMap<>();
    }

Here is the call graph for this function:

Member Function Documentation

notifyMobsimInitialized()

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.notifyMobsimInitialized

(

MobsimInitializedEvent

e

)

Implements org.matsim.core.mobsim.framework.listeners.MobsimInitializedListener.

Definition at line 114 of file ActivityReplanningMap.java.

References org.matsim.withinday.mobsim.MobsimDataProvider.getAgents(), org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin(), org.matsim.core.mobsim.framework.MobsimTimer.getSimStartTime(), and org.matsim.core.mobsim.framework.MobsimTimer.getSimTimestepSize().

                                                                  {

        MobsimTimer mobsimTimer = ((QSim) e.getQueueSimulation()).getSimTimer();
        this.simStartTime = mobsimTimer.getSimStartTime();
        this.timeStepSize = mobsimTimer.getSimTimestepSize();

        this.activityPerformingAgents.clear();

        for (MobsimAgent mobsimAgent : this.mobsimDataProvider.getAgents().values()) {

            // get the agent's activity end time and mark it as currently performing an Activity
            double activityEndTime = mobsimAgent.getActivityEndTime();

            // add the agent to the collections
            this.activityEndTimes.put(mobsimAgent.getId(), activityEndTime);

            int bin = this.getTimeBin(activityEndTime);
            Map<Id<Person>, MobsimAgent> map = getMapForTimeBin(bin);
            map.put(mobsimAgent.getId(), mobsimAgent);
        }

    }

Here is the call graph for this function:

notifyMobsimAfterSimStep()

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.notifyMobsimAfterSimStep

(

MobsimAfterSimStepEvent

e

)

Implements org.matsim.core.mobsim.framework.listeners.MobsimAfterSimStepListener.

Definition at line 144 of file ActivityReplanningMap.java.

References org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin(), and org.matsim.core.mobsim.framework.events.MobsimAfterSimStepEvent< T extends Mobsim >.getSimulationTime().

                                                                    {

        double now = e.getSimulationTime();
        for (MobsimAgent mobsimAgent : startingAgents.values()) {

            double departureTime = mobsimAgent.getActivityEndTime();

            /*
             * If it is the last scheduled Activity the departureTime is -infinity.
             * Otherwise we select the agent for a replanning.
             */
            if (departureTime >= now) {
                this.activityEndTimes.put(mobsimAgent.getId(), departureTime);
                int bin = this.getTimeBin(mobsimAgent.getActivityEndTime());
                Map<Id<Person>, MobsimAgent> map = getMapForTimeBin(bin);
                map.put(mobsimAgent.getId(), mobsimAgent);
            } else {
                log.warn("Departure time is in the past - ignoring activity!");
            }
        }
        this.startingAgents.clear();

        /*
         * Remove current time bin from activityPerformingAgents map. They have been handled
         * in the current time step.
         */
        this.activityPerformingAgents.remove(this.getTimeBin(now));
    }

Here is the call graph for this function:

getMapForTimeBin()

Map<Id<Person>, MobsimAgent> org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin ( int  bin )

private

Definition at line 200 of file ActivityReplanningMap.java.

Referenced by org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getActivityEndingAgents(), org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.handleEvent(), org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.notifyMobsimAfterSimStep(), and org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.notifyMobsimInitialized().

                                                                   {
        Map<Id<Person>, MobsimAgent> map = this.activityPerformingAgents.get(bin);
        if (map == null) {
            map = new HashMap<>();
            this.activityPerformingAgents.put(bin, map);
        }
        return map;
    }

handleEvent() [1/4]

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.handleEvent

(

ActivityStartEvent

event

)

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

Definition at line 214 of file ActivityReplanningMap.java.

References org.matsim.withinday.mobsim.MobsimDataProvider.getAgent().

                                                      {
        Id<Person> agentId = event.getPersonId();
        this.startingAgents.put(agentId, this.mobsimDataProvider.getAgent(agentId));
    }

Here is the call graph for this function:

handleEvent() [2/4]

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.handleEvent

(

ActivityEndEvent

event

)

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

Definition at line 224 of file ActivityReplanningMap.java.

References org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin().

                                                    {
        Id<Person> agentId = event.getPersonId();
        this.startingAgents.remove(agentId);

        Double activityEndTime = this.activityEndTimes.remove(agentId);
        if (activityEndTime != null) {
            Map<Id<Person>, MobsimAgent> map;
            // remove
            map = this.getMapForTimeBin(this.getTimeBin(activityEndTime));
            map.remove(agentId);
        }
    }

Here is the call graph for this function:

handleEvent() [3/4]

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.handleEvent

(

PersonStuckEvent

event

)

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

Definition at line 242 of file ActivityReplanningMap.java.

                                                    {
    }

handleEvent() [4/4]

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.handleEvent

(

ReplanningEvent

event

)

Implements org.matsim.withinday.events.handler.ReplanningEventHandler.

Definition at line 246 of file ActivityReplanningMap.java.

References org.matsim.core.mobsim.framework.MobsimAgent.getActivityEndTime(), org.matsim.withinday.mobsim.MobsimDataProvider.getAgent(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin(), and org.matsim.withinday.events.ReplanningEvent.getPersonId().

                                                   {

        // check whether the agent is performing an activity
        Double activityEndTime = this.activityEndTimes.get(event.getPersonId());
        if (activityEndTime != null) {

            // check whether the agent has changed its planned departure time
            MobsimAgent agent = this.mobsimDataProvider.getAgent(event.getPersonId());
            if (activityEndTime != agent.getActivityEndTime()) {
                // Update the agent's activity end time.
                this.activityEndTimes.put(agent.getId(), agent.getActivityEndTime());

                // Update the activity performing agents map. To do so, remove old entry and add new one.
                Map<Id<Person>, MobsimAgent> map;
                // remove
                map = this.getMapForTimeBin(this.getTimeBin(activityEndTime));
                map.remove(agent.getId());

                // add
                map = this.getMapForTimeBin(this.getTimeBin(agent.getActivityEndTime()));
                map.put(agent.getId(), agent);
            }
        }
    }

Here is the call graph for this function:

getActivityPerformingAgents()

Set<Id<Person> > org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getActivityPerformingAgents

(

)

Returns a set containing the Ids of all agents that are currently performing an activity.

Definition at line 274 of file ActivityReplanningMap.java.

Referenced by org.matsim.withinday.replanning.identifiers.ActivityPerformingIdentifier.getAgentsToReplan().

                                                         {
        return Collections.unmodifiableSet(this.activityEndTimes.keySet());
    }

getActivityEndingAgents()

Collection<MobsimAgent> org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getActivityEndingAgents

(

double

time

)

Returns a Collection containing all agents that are going to end their activity in the time step belongs to the given time. Typically, this is the current simulation time. For times in the past an empty set is returned. Since in data structure in the background the MobsimAgents are available, we return them instead of only their Ids as the getActivityPerformingAgents() method does.

Definition at line 285 of file ActivityReplanningMap.java.

References org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.getMapForTimeBin().

Referenced by org.matsim.withinday.replanning.identifiers.ActivityEndIdentifier.getAgentsToReplan().

                                                                        {
        return Collections.unmodifiableCollection(this.getMapForTimeBin(this.getTimeBin(time)).values());
    }

Here is the call graph for this function:

reset()

void org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.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 290 of file ActivityReplanningMap.java.

                                     {
        this.startingAgents.clear();
        this.activityEndTimes.clear();
    }

Member Data Documentation

log

final Logger org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.log = LogManager.getLogger(ActivityReplanningMap.class)

staticprivate

Definition at line 64 of file ActivityReplanningMap.java.

mobsimDataProvider

final MobsimDataProvider org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.mobsimDataProvider

private

Definition at line 66 of file ActivityReplanningMap.java.

Referenced by org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.ActivityReplanningMap().

startingAgents

final Map<Id<Person>, MobsimAgent> org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.startingAgents

private

Definition at line 76 of file ActivityReplanningMap.java.

activityEndTimes

final Map<Id<Person>, Double> org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.activityEndTimes

private

Definition at line 84 of file ActivityReplanningMap.java.

activityPerformingAgents

final Map<Integer, Map<Id<Person>, MobsimAgent> > org.matsim.withinday.replanning.identifiers.tools.ActivityReplanningMap.activityPerformingAgents

private

Definition at line 90 of file ActivityReplanningMap.java.

---

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

• withinday/replanning/identifiers/tools/ActivityReplanningMap.java