Class TraceSet

All Implemented Interfaces:
NamedObjectOps

public class TraceSet extends DefaultSimObject
Set of properties for tracing simulation objects This class determines the output for tracing and a trace level to aid in debugging. The output can be any Appendable (the Appendable interface is implements by System.out, etc.) Simulation objects that are to be traced can add a trace set to a list (actually a set as a given trace set can appear only once), and when SimObject.trace(int,String,Object...) or SimObject.trace(Enum,String,Object...) is called, each of the simulation's objects' trace sets will contain the traced output. The class SimpleConsole implements the Appendable interface and can be used to put trace output in a console window when a GUI is provided.

A print level determines what outputs are shown: objects will call a method named SimObject.trace(int, java.lang.String, java.lang.Object...) that takes a level as its argument. If that level exceeds the level for a trace set, nothing will be printed for that trace set. A simulation object can be members of multiple trace sets. When this is done the trace sets should use different outputs. For example, one can trace a relatively large number of objects with a low trace level and a smaller subset with a high trace level.

When SimObject.trace(int, java.lang.String, java.lang.Object...) is called, a formatted message will appear on the output, prefixed by the object name and the current time, and terminated by a newline. Optionally a stack trace can be added (one must call setStackTraceMode(boolean) with an argument equal to true to turn this capability on). The stack trace is useful in cases were the trace shows anomalous behavior and the calling sequence would be useful in debugging the problem.

A simulation object is added to a trace set by calling the simulation object's method SimObject.addTraceSet(TraceSet) and removed by calling SimObject.removeTraceSet(TraceSet).

  • Constructor Details

    • TraceSet

      public TraceSet(Simulation sim, String name, boolean intern)
      Constructor for interned objects. These objects can be looked up by name using the methods in Simulation.
      Parameters:
      sim - the simulation
      name - the name of the object; null for an automatically generated name
      intern - true if the object can be looked up by using the methods in Simulation; false otherwise.
      Throws:
      IllegalArgumentException - typically means a name is already in use
      See Also:
  • Method Details

    • onDelete

      protected void onDelete()
      Complete the actions necessary to delete a named object. A subclass that overrides this method must call super.onDelete() at some point to complete the object deletion. This may not be within the onDelete method of the subclass if the deletion must be delayed for some reason (e.g., until some processing that is in progress has been completed). Once called, the object will be removed from the object-namer's tables and the object will be marked as deleted, so in general cleanup actions by a subclass should occur before it calls super.onDelete().
      Overrides:
      onDelete in class SimObject
    • setLevel

      public void setLevel(int level)
      Set the trace level.
      Parameters:
      level - the trace level
    • getLevel

      public int getLevel()
      Get the trace level.
      Returns:
      the trace level
    • setStackTraceMode

      public void setStackTraceMode(boolean mode)
      Set the stacktrace mode.
      Parameters:
      mode - true if a stack trace should be printed when trace output is displayed; false otherwise
    • setStackTraceLimit

      public void setStackTraceLimit(int limit) throws IllegalArgumentException
      Set the stack-trace limit. The stack-trace limit is the maximum number of stack frames that will be printed.
      Parameters:
      limit - 0 if there is no limit; otherwise a positive number giving value of the limit
      Throws:
      IllegalArgumentException - the argument was negative
    • getStackTraceMode

      public boolean getStackTraceMode()
      Get the stack-trace mode.
      Returns:
      the stacktrace mode (true if a stacktrace will be displayed; false if not)
    • getStackTraceLimit

      public int getStackTraceLimit()
      Get the stack-trace limit. The stack-trace limit is the maximum number of stack frames that will be printed.
      Returns:
      0 if there is no limit; otherwise the value of the limit
    • setOutput

      public void setOutput(Appendable appendable)
      Set the per trace set output.
      Parameters:
      appendable - the appendable to use for output; null if the simulation default should be used
    • clone

      protected Object clone() throws CloneNotSupportedException
      Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException - a clone could not be created
      See Also:
    • isInterned

      public boolean isInterned()
      Determine if an object is interned in a object namer's tables.
      Specified by:
      isInterned in interface NamedObjectOps
      Returns:
      true if the object is interned; false if not
    • getObjectNamer

      protected Simulation getObjectNamer()
      Get the object namer for a named object.
      Returns:
      the object namer for this named object
    • getName

      public final String getName()
      Get an object's name.
      Specified by:
      getName in interface NamedObjectOps
      Returns:
      the name of the object
    • canDelete

      public boolean canDelete()
      Determine if this named object can be deleted. A named object can be deleted if the method delete has not been called and if the object is not in a state that prevents the object from being deleted. Subclasses that override this method must call canDelete() for their superclasses and return false if the superclass' canDelete method returns false. The default method returns true if delete() has not been called and returned true.
      Specified by:
      canDelete in interface NamedObjectOps
      Returns:
      true if this object can be deleted; false otherwise
    • delete

      public final boolean delete()
      Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.

      The implementations provided by DefaultNamedObect and generated because of a @NamedObject annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).

      Specified by:
      delete in interface NamedObjectOps
      Returns:
      true if the deletion request was accepted; false otherwise
    • isDeleted

      public final boolean isDeleted()
      Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.
      Specified by:
      isDeleted in interface NamedObjectOps
      Returns:
      true if deleted; false otherwise
    • deletePending

      public final boolean deletePending()
      Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.
      Specified by:
      deletePending in interface NamedObjectOps
      Returns:
      true if deletion is pending; false otherwise