org.matsim.core.mobsim.qsim.TeleportationEngine Class Reference

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

Public Member Functions
	TeleportationEngine (Scenario scenario, EventsManager eventsManager)
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)
Collection< AgentSnapshotInfo >	addAgentSnapshotInfo (final Collection< AgentSnapshotInfo > positions)

Private Member Functions
void	handleTeleportationArrivals ()

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 = Logger.getLogger( TeleportationEngine.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 30 of file TeleportationEngine.java.

Constructor & Destructor Documentation

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

Definition at line 54 of file TeleportationEngine.java.

References org.matsim.core.mobsim.qsim.TeleportationEngine.eventsManager, org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.config.Config.qsim(), and org.matsim.core.mobsim.qsim.TeleportationEngine.scenario.

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

Here is the call graph for this function:

Member Function Documentation

boolean org.matsim.core.mobsim.qsim.TeleportationEngine.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 62 of file TeleportationEngine.java.

References org.matsim.api.core.v01.Scenario.getConfig(), org.matsim.core.mobsim.framework.MobsimAgent.getCurrentFacility(), org.matsim.core.mobsim.framework.MobsimAgent.getDestinationFacility(), org.matsim.core.mobsim.framework.NetworkAgent.getDestinationLinkId(), org.matsim.core.mobsim.framework.MobsimAgent.getExpectedTravelTime(), org.matsim.api.core.v01.network.Network.getLinks(), org.matsim.core.mobsim.framework.NetworkAgent.getMode(), org.matsim.api.core.v01.Scenario.getNetwork(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getTeleportedModeSpeeds(), org.matsim.api.core.v01.network.Link.getToNode(), org.matsim.core.config.Config.plansCalcRoute, org.matsim.core.mobsim.qsim.TeleportationEngine.travelTimeCheck(), and org.matsim.core.utils.misc.Time.UNDEFINED_TIME.

                                                                                   {
        if ( agent.getExpectedTravelTime()==null || agent.getExpectedTravelTime()==Time.UNDEFINED_TIME ) {
            Logger.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() ;
        if ( withTravelTimeCheck ) {
            Double speed = scenario.getConfig().plansCalcRoute().getTeleportedModeSpeeds().get( agent.getMode() ) ;
            Facility<?> dpfac = agent.getCurrentFacility() ;
            Facility<?> arfac = agent.getDestinationFacility() ;
            travelTime = TeleportationEngine.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:

Collection<AgentSnapshotInfo> org.matsim.core.mobsim.qsim.TeleportationEngine.addAgentSnapshotInfo

(

Collection< AgentSnapshotInfo >

snapshotList

)

Definition at line 93 of file TeleportationEngine.java.

References org.matsim.core.mobsim.qsim.InternalInterface.getMobsim(), org.matsim.core.mobsim.qsim.interfaces.Netsim.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:

void org.matsim.core.mobsim.qsim.TeleportationEngine.doSimStep

(

double

time

)

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

Definition at line 103 of file TeleportationEngine.java.

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

                                       {
        handleTeleportationArrivals();
    }

Here is the call graph for this function:

void org.matsim.core.mobsim.qsim.TeleportationEngine.handleTeleportationArrivals ( )

private

Definition at line 107 of file TeleportationEngine.java.

References org.matsim.core.mobsim.qsim.InternalInterface.arrangeNextAgentState(), org.matsim.core.mobsim.framework.MobsimAgent.endLegAndComputeNextState(), org.matsim.core.mobsim.framework.MobsimAgent.getExpectedTravelDistance(), org.matsim.core.mobsim.qsim.InternalInterface.getMobsim(), org.matsim.core.mobsim.qsim.interfaces.Netsim.getSimTimer(), org.matsim.core.mobsim.framework.MobsimTimer.getTimeOfDay(), org.matsim.core.mobsim.framework.MobsimAgent.notifyArrivalOnLinkByNonNetworkMode(), and org.matsim.core.api.experimental.events.EventsManager.processEvent().

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

                                               {
        double now = internalInterface.getMobsim().getSimTimer().getTimeOfDay();
        while (teleportationList.peek() != null) {
            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(this.internalInterface.getMobsim().getSimTimer().getTimeOfDay(), personAgent.getId(), distance));
                personAgent.endLegAndComputeNextState(now);
                this.teleportationData.remove(personAgent.getId());
                internalInterface.arrangeNextAgentState(personAgent);
            } else {
                break;
            }
        }
    }

Here is the call graph for this function:

void org.matsim.core.mobsim.qsim.TeleportationEngine.onPrepareSim

(

)

called in a predefined Order when the simulation is started

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

Definition at line 128 of file TeleportationEngine.java.

                               {

    }

void org.matsim.core.mobsim.qsim.TeleportationEngine.afterSim

(

)

Do some clean up.

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

Definition at line 133 of file TeleportationEngine.java.

References org.matsim.core.mobsim.framework.NetworkAgent.getDestinationLinkId(), org.matsim.core.mobsim.qsim.InternalInterface.getMobsim(), org.matsim.core.mobsim.framework.NetworkAgent.getMode(), org.matsim.core.mobsim.qsim.interfaces.Netsim.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:

void org.matsim.core.mobsim.qsim.TeleportationEngine.setInternalInterface

(

InternalInterface

internalInterface

)

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

Definition at line 143 of file TeleportationEngine.java.

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

                                                                          {
        this.internalInterface = internalInterface;
    }

static Double org.matsim.core.mobsim.qsim.TeleportationEngine.travelTimeCheck ( Double  travelTime, Double  speed, Facility<?>  dpfac, Facility<?>  arfac  )

staticprivate

Definition at line 147 of file TeleportationEngine.java.

References org.matsim.core.network.NetworkUtils.getEuclideanDistance().

Referenced by org.matsim.core.mobsim.qsim.TeleportationEngine.handleDeparture().

                                                                                                                 {
        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 ;
    }

Here is the call graph for this function:

Collection<AgentSnapshotInfo> org.matsim.vis.snapshotwriters.VisData.addAgentSnapshotInfo ( final Collection< AgentSnapshotInfo >  positions )

inherited

Referenced by org.matsim.core.mobsim.qsim.QSim.getNonNetworkAgentSnapshots().

Member Data Documentation

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

staticprivate

Definition at line 32 of file TeleportationEngine.java.

final Queue<Tuple<Double, MobsimAgent> > org.matsim.core.mobsim.qsim.TeleportationEngine.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 34 of file TeleportationEngine.java.

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

private

Definition at line 46 of file TeleportationEngine.java.

InternalInterface org.matsim.core.mobsim.qsim.TeleportationEngine.internalInterface

private

Definition at line 47 of file TeleportationEngine.java.

Referenced by org.matsim.core.mobsim.qsim.TeleportationEngine.setInternalInterface().

Scenario org.matsim.core.mobsim.qsim.TeleportationEngine.scenario

private

Definition at line 48 of file TeleportationEngine.java.

Referenced by org.matsim.core.mobsim.qsim.TeleportationEngine.TeleportationEngine().

EventsManager org.matsim.core.mobsim.qsim.TeleportationEngine.eventsManager

private

Definition at line 49 of file TeleportationEngine.java.

Referenced by org.matsim.core.mobsim.qsim.TeleportationEngine.TeleportationEngine().

final boolean org.matsim.core.mobsim.qsim.TeleportationEngine.withTravelTimeCheck

private

Definition at line 51 of file TeleportationEngine.java.

---

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

• org/matsim/core/mobsim/qsim/TeleportationEngine.java