Package org.opentrafficsim.core.perception

Interface PerceivableContext

All Superinterfaces:
org.djutils.base.Identifiable
All Known Implementing Classes:
ExpansionNetwork, Network
public interface PerceivableContext extends org.djutils.base.Identifiable
The Model package guarantees that objects that are used in an OTS study such as GTUs are retrievable. In a spatial model, for instance, objects need to be able to find each other. The model interface guarantees access to a number of important objects in the study.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:
Alexander Verbraeck, Peter Knoppers

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addGTU(Gtu gtu)
    Add a GTU to the network.
    boolean
    containsGTU(Gtu gtu)
    Test whether a GTU is registered in the network.
    boolean
    containsGtuId(String gtuId)
    Test whether a GTU ID is registered in the network.
    Gtu
    getGTU(String gtuId)
    Get a GTU in the model.
    Set<Gtu>
    getGTUs()
    Get an overview of the GTUs in the model.
    String
    getId()
    Get a descriptive Id of the perceivable context (e.g., useful for debugging purposes).
    void
    removeGTU(Gtu gtu)
    Remove a GTU from the network.

  • Method Details

    • getId

      String getId()
      Get a descriptive Id of the perceivable context (e.g., useful for debugging purposes).
      Specified by:
      getId in interface org.djutils.base.Identifiable
      Returns:
      the id of the context

    • getGTUs

      Set<Gtu> getGTUs()
      Get an overview of the GTUs in the model. The set returned is a defensive copy.
      Returns:
      a set of GTUs as registered in the current model.

    • getGTU

      Gtu getGTU(String gtuId)
      Get a GTU in the model.
      Parameters:
      gtuId - String; the id of the GTU
      Returns:
      a GTU as registered in the current model, or null when the id could not be found.

    • addGTU

      void addGTU(Gtu gtu)
      Add a GTU to the network.
      Parameters:
      gtu - Gtu; the GTU to add

    • removeGTU

      void removeGTU(Gtu gtu)
      Remove a GTU from the network.
      Parameters:
      gtu - Gtu; the GTU to remove

    • containsGTU

      boolean containsGTU(Gtu gtu)
      Test whether a GTU is registered in the network.
      Parameters:
      gtu - Gtu; the GTU to search for
      Returns:
      whether the network contains this GTU

    • containsGtuId

      boolean containsGtuId(String gtuId)
      Test whether a GTU ID is registered in the network.
      Parameters:
      gtuId - String; the GTU ID to search for
      Returns:
      whether the network contains a GTU with this ID