QLinkI.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2010 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.mobsim.qsim.qnetsimengine;

import java.util.Collection;
import java.util.List;
import java.util.Set;

import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.population.Person;
import org.matsim.core.mobsim.framework.MobsimAgent;
import org.matsim.core.mobsim.framework.MobsimDriverAgent;
import org.matsim.core.mobsim.qsim.interfaces.MobsimVehicle;
import org.matsim.core.mobsim.qsim.interfaces.NetsimLink;
import org.matsim.core.mobsim.qsim.interfaces.TimeVariantLink;
import org.matsim.vehicles.Vehicle;

public interface QLinkI extends NetsimLink, TimeVariantLink {
    // yyyy might make make sense to also pass the "isAccepting/addFromUpstream" through something like 
    // "getFromNodeQueueLanes". kai, feb'16
    
    // yyyy my intuition is to unify all the "registerDriverAgentForCar" etc. methods into something like
    // registerAdditionalAgentOnLink( MobsimAgent agent, String reason ) ;
    

    QNodeI getToNode() ;

    void addParkedVehicle(MobsimVehicle vehicle) ;
    
    QVehicle removeParkedVehicle(Id<Vehicle> vehicleId) ;

    QVehicle getParkedVehicle(Id<Vehicle> vehicleId) ; 
    
    void registerAdditionalAgentOnLink(MobsimAgent planAgent) ;

    MobsimAgent unregisterAdditionalAgentOnLink(Id<Person> mobsimAgentId) ;

    Collection<MobsimAgent> getAdditionalAgentsOnLink() ;
    
    void letVehicleDepart(QVehicle vehicle) ;

    boolean insertPassengerIntoVehicle(MobsimAgent passenger, Id<Vehicle> vehicleId);
    
    QVehicle getVehicle(Id<Vehicle> vehicleId) ;
    
    void registerDriverAgentWaitingForCar(final MobsimDriverAgent agent) ;
    
    void registerDriverAgentWaitingForPassengers(MobsimDriverAgent agent) ;
    MobsimAgent unregisterDriverAgentWaitingForPassengers(Id<Person> agentId) ;
    
    void registerPassengerAgentWaitingForCar(MobsimAgent agent, Id<Vehicle> vehicleId) ;
    MobsimAgent unregisterPassengerAgentWaitingForCar(MobsimAgent agent, Id<Vehicle> vehicleId) ;

    
    Set<MobsimAgent> getAgentsWaitingForCar(Id<Vehicle> vehicleId) ;

    List<QLaneI> getOfferingQLanes() ;

    boolean doSimStep();

    void clearVehicles();

    boolean isNotOfferingVehicle();

    QLaneI getAcceptingQLane() ;

}