Inheritance diagram for org.matsim.core.mobsim.qsim.DefaultTeleportationEngine:

[legend]

Public Member Functions
	DefaultTeleportationEngine (Scenario scenario, EventsManager eventsManager)

	DefaultTeleportationEngine (Scenario scenario, EventsManager eventsManager, boolean withTravelTimeCheck)

boolean	handleDeparture (double now, MobsimAgent agent, Id< Link > linkId)

Collection< AgentSnapshotInfo >	addAgentSnapshotInfo (Collection< AgentSnapshotInfo > snapshotList)

void	doSimStep (double time)

void	onPrepareSim ()

void	afterSim ()

void	setInternalInterface (InternalInterface internalInterface)

Private Member Functions
void	handleTeleportationArrivals (double now)

Static Private Member Functions
static Double	travelTimeCheck (Double travelTime, Double speed, Facility dpfac, Facility arfac)

Private Attributes
final Queue< Tuple< Double, MobsimAgent > >	teleportationList

final LinkedHashMap< Id< Person >, TeleportationVisData >	teleportationData = new LinkedHashMap<>()

InternalInterface	internalInterface

Scenario	scenario

EventsManager	eventsManager

final boolean	withTravelTimeCheck

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

Detailed Description

Includes all agents that have transportation modes unknown to the NetsimEngine (often all != "car") or have two activities on the same link

Definition at line 53 of file DefaultTeleportationEngine.java.

Constructor & Destructor Documentation

◆ DefaultTeleportationEngine() [1/2]

org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.DefaultTeleportationEngine	(	Scenario	scenario,
		EventsManager	eventsManager
	)

Definition at line 79 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.eventsManager, org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.config.groups.QSimConfigGroup.isUsingTravelTimeCheckInTeleportation(), org.matsim.core.config.Config.qsim(), and org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.scenario.

                                                                                       {
         this(scenario, eventsManager, scenario.getConfig().qsim().isUsingTravelTimeCheckInTeleportation());
     }

Here is the call graph for this function:

◆ DefaultTeleportationEngine() [2/2]

org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.DefaultTeleportationEngine	(	Scenario	scenario,
		EventsManager	eventsManager,
		boolean	withTravelTimeCheck
	)

Definition at line 83 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.eventsManager, org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.scenario, and org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.withTravelTimeCheck.

                                                                                                                    {
         this.scenario = scenario;
         this.eventsManager = eventsManager;
         this.withTravelTimeCheck = withTravelTimeCheck;
     }

Member Function Documentation

◆ handleDeparture()

boolean org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.handleDeparture	(	double	now,
		MobsimAgent	agent,
		Id< Link >	linkId
	)

Returns: true if the departure is handled, false if other DepartureHandlers should be tried as well.

Implements org.matsim.core.mobsim.qsim.interfaces.DepartureHandler.

Definition at line 90 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.framework.MobsimAgent.getExpectedTravelTime(), org.matsim.core.mobsim.framework.NetworkAgent.getMode(), and org.matsim.core.utils.misc.OptionalTime.isUndefined().

                                                                                    {
         if (agent.getExpectedTravelTime().isUndefined()) {
             LogManager.getLogger(this.getClass()).info("mode: " + agent.getMode());
             throw new RuntimeException("teleportation does not work when travel time is undefined.  There is also really no magic fix for this,"
                     + " since we cannot guess travel times for arbitrary modes and arbitrary landscapes.  kai/mz, apr'15 & feb'16") ;
         }
 
         double travelTime = agent.getExpectedTravelTime().seconds() ;
         if ( withTravelTimeCheck ) {
             Double speed = scenario.getConfig().routing().getTeleportedModeSpeeds().get( agent.getMode() ) ;
             Facility dpfac = agent.getCurrentFacility() ;
             Facility arfac = agent.getDestinationFacility() ;
             travelTime = DefaultTeleportationEngine.travelTimeCheck(travelTime, speed, dpfac, arfac);
         }
 
         double arrivalTime = now + travelTime ;
         this.teleportationList.add(new Tuple<>(arrivalTime, agent));
 
         // === below here is only visualization, no dynamics ===
         Id<Person> agentId = agent.getId();
         Link currLink = this.scenario .getNetwork().getLinks().get(linkId);
         Link destLink = this.scenario .getNetwork().getLinks().get(agent.getDestinationLinkId());
         Coord fromCoord = currLink.getToNode().getCoord();
         Coord toCoord = destLink.getToNode().getCoord();
         TeleportationVisData agentInfo = new TeleportationVisData(now, agentId, fromCoord, toCoord, travelTime);
         this.teleportationData.put(agentId, agentInfo);
 
         return true;
     }

Here is the call graph for this function:

◆ addAgentSnapshotInfo()

Collection<AgentSnapshotInfo> org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.addAgentSnapshotInfo ( Collection< AgentSnapshotInfo > snapshotList )

Implements org.matsim.vis.snapshotwriters.VisData.

Definition at line 121 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.InternalInterface.getMobsim(), org.matsim.core.mobsim.qsim.QSim.getSimTimer(), and org.matsim.core.mobsim.framework.MobsimTimer.getTimeOfDay().

                                                                                                           {
         double time = internalInterface.getMobsim().getSimTimer().getTimeOfDay();
         for (TeleportationVisData teleportationVisData : teleportationData.values()) {
             teleportationVisData.updatePosition(time);
             snapshotList.add(teleportationVisData);
         }
         return snapshotList;
     }

Here is the call graph for this function:

◆ doSimStep()

void org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.doSimStep ( double time )

Implements org.matsim.core.mobsim.framework.Steppable.

Definition at line 131 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.handleTeleportationArrivals().

                                        {
         handleTeleportationArrivals(time);
     }

Here is the call graph for this function:

◆ handleTeleportationArrivals()

void org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.handleTeleportationArrivals ( double now )

private

Definition at line 135 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.InternalInterface.arrangeNextAgentState(), org.matsim.core.mobsim.framework.MobsimAgent.endLegAndComputeNextState(), org.matsim.core.mobsim.framework.NetworkAgent.getDestinationLinkId(), org.matsim.core.mobsim.framework.MobsimAgent.getExpectedTravelDistance(), org.matsim.core.utils.collections.Tuple< A, B >.getFirst(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.core.mobsim.framework.NetworkAgent.getMode(), org.matsim.core.utils.collections.Tuple< A, B >.getSecond(), org.matsim.core.mobsim.framework.MobsimAgent.notifyArrivalOnLinkByNonNetworkMode(), and org.matsim.core.api.experimental.events.EventsManager.processEvent().

Referenced by org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.doSimStep().

                                                          {
         while (!teleportationList.isEmpty()) {
             Tuple<Double, MobsimAgent> entry = teleportationList.peek();
             if (entry.getFirst() <= now) {
                 teleportationList.poll();
                 MobsimAgent personAgent = entry.getSecond();
                 personAgent.notifyArrivalOnLinkByNonNetworkMode(personAgent.getDestinationLinkId());
                 double distance = personAgent.getExpectedTravelDistance();
                 this.eventsManager.processEvent(
                         new TeleportationArrivalEvent(now, personAgent.getId(), distance, personAgent.getMode()));
                 personAgent.endLegAndComputeNextState(now);
                 this.teleportationData.remove(personAgent.getId());
                 internalInterface.arrangeNextAgentState(personAgent);
             } else {
                 break;
             }
         }
     }

Here is the call graph for this function:

◆ onPrepareSim()

void org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.onPrepareSim ( )

called in a predefined Order when the simulation is started

Implements org.matsim.core.mobsim.qsim.interfaces.MobsimEngine.

Definition at line 155 of file DefaultTeleportationEngine.java.

155 {

156 }

◆ afterSim()

void org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.afterSim ( )

Do some clean up.

Implements org.matsim.core.mobsim.qsim.interfaces.MobsimEngine.

Definition at line 159 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.framework.NetworkAgent.getDestinationLinkId(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.core.mobsim.qsim.InternalInterface.getMobsim(), org.matsim.core.mobsim.framework.NetworkAgent.getMode(), org.matsim.core.mobsim.qsim.QSim.getSimTimer(), org.matsim.core.mobsim.framework.MobsimTimer.getTimeOfDay(), and org.matsim.core.api.experimental.events.EventsManager.processEvent().

                            {
         double now = internalInterface.getMobsim().getSimTimer().getTimeOfDay();
         for (Tuple<Double, MobsimAgent> entry : teleportationList) {
             MobsimAgent agent = entry.getSecond();
             eventsManager.processEvent(new PersonStuckEvent(now, agent.getId(), agent.getDestinationLinkId(), agent.getMode()));
         }
         teleportationList.clear();
     }

Here is the call graph for this function:

◆ setInternalInterface()

void org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.setInternalInterface ( InternalInterface internalInterface )

Implements org.matsim.core.mobsim.qsim.interfaces.MobsimEngine.

Definition at line 169 of file DefaultTeleportationEngine.java.

References org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.internalInterface.

                                                                           {
         this.internalInterface = internalInterface;
     }

◆ travelTimeCheck()

static Double org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.travelTimeCheck	(	Double	travelTime,
		Double	speed,
		Facility	dpfac,
		Facility	arfac
	)

staticprivate

Definition at line 173 of file DefaultTeleportationEngine.java.

                                                                                                            {
         if ( speed==null ) {
             // if we don't have a bushwhacking speed, the only thing we can do is trust the router
             return travelTime ;
         }
 
         if ( dpfac == null || arfac == null ) {
             log.warn( "dpfac = " + dpfac ) ;
             log.warn( "arfac = " + arfac ) ;
             throw new RuntimeException("have bushwhacking mode but nothing that leads to coordinates; don't know what to do ...") ;
             // (means that the agent is not correctly implemented)
         }
 
         if ( dpfac.getCoord()==null || arfac.getCoord()==null ) {
             // yy this is for example the case if activities are initialized at links, without coordinates.  Could use the link coordinate
             // instead, but somehow this does not feel any better. kai, feb'16
 
             return travelTime ;
         }
 
         final Coord dpCoord = dpfac.getCoord();
         final Coord arCoord = arfac.getCoord();
 
         double dist = NetworkUtils.getEuclideanDistance( dpCoord, arCoord ) ;
         double travelTimeTmp = dist / speed ;
 
         if ( travelTimeTmp < travelTime ) {
             return travelTime ;
         }
 
         return travelTimeTmp ;
     }

Member Data Documentation

◆ log

final Logger org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.log = LogManager.getLogger( DefaultTeleportationEngine.class )

staticprivate

Definition at line 54 of file DefaultTeleportationEngine.java.

◆ teleportationList

final Queue<Tuple<Double, MobsimAgent> > org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.teleportationList

private

Initial value:

= new PriorityQueue<>(
            30, new Comparator<Tuple<Double, MobsimAgent>>() {
        @Override
        public int compare(Tuple<Double, MobsimAgent> o1, Tuple<Double, MobsimAgent> o2) {
            int ret = o1.getFirst().compareTo(o2.getFirst()); 
            if (ret == 0) {
                ret = o2.getSecond()
                        .getId()
                        .compareTo(o1.getSecond()
                                .getId()); 
            }
            return ret;
        }
    })

Definition at line 56 of file DefaultTeleportationEngine.java.

◆ teleportationData

final LinkedHashMap<Id<Person>, TeleportationVisData> org.matsim.core.mobsim.qsim.DefaultTeleportationEngine.teleportationData = new LinkedHashMap<>()

private

Definition at line 71 of file DefaultTeleportationEngine.java.