Package org.opentrafficsim.road.gtu

Class Break

java.lang.Object
org.opentrafficsim.road.gtu.Break
public final class Break extends Object
Utility to make debugging on a specific GTU more convenient. There is a method on() for a GTU and for perception. Should neither be available within the context of a method that needs to be debugged, onSub() can be used in combination with onSuper() at a higher-level method with a GTU or perception. This class requires the user to set a break point in the method trigger().

Copyright (c) 2013-2026 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, Wouter Schakel

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    on(Gtu gtu, String id, double time, boolean additionalCondition)
    Break on GTU and double time.
    static void
    on(Gtu gtu, String id, String time, boolean additionalCondition)
    Break on GTU and String of time.
    static void
    on(Perception<?> perception, String id, double time, boolean additionalCondition)
    Break on perception and double time.
    static void
    on(Perception<?> perception, String id, String time, boolean additionalCondition)
    Break on perception and String of time.
    static void
    on(TacticalContextEgo context, String id, double time, boolean additionalCondition)
    Break on perception and double time.
    static void
    onSub()
    This method can be used if the context of a lower-level function does not contain the information on which to break.
    static void
    onSub(boolean additionalCondition)
    This method can be used if the context of a lower-level function does not contain the information on which to break.
    static void
    onSuper(Gtu gtu, String id, double time, boolean additionalCondition)
    Sets a break condition to true which is triggered by onSub() at a lower level where context is insufficient to determine the break condition.
    static void
    onSuper(Perception<?> perception, String id, double time, boolean additionalCondition)
    Sets a break condition to true which is triggered by onSub() at a lower level where context is insufficient to determine the break condition.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • onSuper

      public static void onSuper(Perception<?> perception, String id, double time, boolean additionalCondition)
      Sets a break condition to true which is triggered by onSub() at a lower level where context is insufficient to determine the break condition.
      Parameters:
      perception - perception to obtain gtu from
      id - GTU id to break on
      time - time to break at (or after)
      additionalCondition - additional condition

    • onSuper

      public static void onSuper(Gtu gtu, String id, double time, boolean additionalCondition)
      Sets a break condition to true which is triggered by onSub() at a lower level where context is insufficient to determine the break condition.
      Parameters:
      gtu - GTU
      id - GTU id to break on
      time - time to break at (or after)
      additionalCondition - additional condition

    • onSub

      public static void onSub()
      This method can be used if the context of a lower-level function does not contain the information on which to break. This method will only trigger a break if at a higher-level function where the context was sufficient, the break condition was set to true using onSuper().

    • onSub

      public static void onSub(boolean additionalCondition)
      This method can be used if the context of a lower-level function does not contain the information on which to break. This method will only trigger a break if at a higher-level function where the context was sufficient, the break condition was set to true using onSuper().
      Parameters:
      additionalCondition - additional condition

    • on

      public static void on(Perception<?> perception, String id, String time, boolean additionalCondition)
      Break on perception and String of time.
      Parameters:
      perception - perception to obtain gtu from
      id - GTU id to break on
      time - time to break at (or after), in format ss, mm:ss or hh:mm:ss
      additionalCondition - additional condition

    • on

      public static void on(Perception<?> perception, String id, double time, boolean additionalCondition)
      Break on perception and double time.
      Parameters:
      perception - perception to obtain gtu from
      id - GTU id to break on
      time - time to break at (or after)
      additionalCondition - additional condition

    • on

      public static void on(TacticalContextEgo context, String id, double time, boolean additionalCondition)
      Break on perception and double time.
      Parameters:
      context - tactical information such as parameters and car-following model
      id - GTU id to break on
      time - time to break at (or after)
      additionalCondition - additional condition

    • on

      public static void on(Gtu gtu, String id, String time, boolean additionalCondition)
      Break on GTU and String of time.
      Parameters:
      gtu - GTU
      id - GTU id to break on
      time - time to break at (or after), in format ss, mm:ss or hh:mm:ss
      additionalCondition - additional condition

    • on

      public static void on(Gtu gtu, String id, double time, boolean additionalCondition)
      Break on GTU and double time.
      Parameters:
      gtu - GTU
      id - GTU id to break on
      time - time to break at (or after)
      additionalCondition - additional condition