Class WaitTaskQueue

All Implemented Interfaces:
QueueStatus, NamedObjectOps

public class WaitTaskQueue extends AbstractWaitTaskQueue
Class for wait task queues. Unless a subclass specifies otherwise, instances of WaitTaskQueue are initially frozen so that all entries added to the queue are queued and not run until explicitly released. The methods that allow entries to be run when the queue is frozen are release, releaseUpTo, and and clearReleaseCount. Either these or the method freeze ( with an argument whose value is false). Otherwise the queue will never decrease in size. For subclasses in which freeze must not be used, the protected method setCanFreeze should be called with an argument of false after the queue is properly configured.
  • Constructor Details

    • WaitTaskQueue

      public WaitTaskQueue(Simulation sim, boolean intern)
      Constructor.
      Parameters:
      sim - the simulation
      intern - true of the queue should be interned in the simulation's name table; false otherwise
    • WaitTaskQueue

      public WaitTaskQueue(Simulation sim, String name, boolean intern) throws IllegalArgumentException
      Constructor for named queues.
      Parameters:
      sim - the simulation
      name - the name for the queue
      intern - true of the queue should be interned in the simulation's name table; false otherwise
      Throws:
      IllegalArgumentException - typically means a name is already in use
  • Method Details

    • 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
    • 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