Class GenericCondition<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>>

java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.drama.generic.GenericSimObject<S,A,C,D,DM,F,G>
org.bzdev.drama.generic.GenericTaskObject<S,A,C,D,DM,F,G>
org.bzdev.drama.generic.GenericCondition<S,A,C,D,DM,F,G>
All Implemented Interfaces:
NamedObjectOps
Direct Known Subclasses:
Condition

public abstract class GenericCondition<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>> extends GenericTaskObject<S,A,C,D,DM,F,G>
Class representing a condition. Conditions represent quantities that are part of the global state of a simulation, but that are not represented by actors or other more specific simulation objects. Domains and user-defined condition observers will be notified when a condition changes.

Conditions can be used for a variety of purposes, including turning on or off debugging for all the actors associated with a given domain. The simplest conditions simply provide a value.

When a condition changes its state, the object that changed the state is expected to call notifyObservers() followed by completeNotification(). The use of two methods allows objects to queue up multiple notifications and apply them at once.

As a general rule, it is preferable to send as few notifications as possible. For example, if a condition represents a value that is changing with time, one might represent the condition by a value at some time and the rate of change, sending notifications only when new values or rates of change are needed.

  • Constructor Details

    • GenericCondition

      protected GenericCondition(S sim, String name, boolean intern) throws IllegalArgumentException
      Constructor.
      Parameters:
      sim - the simulation
      name - the name of the condition
      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
  • 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 GenericTaskObject<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>>
    • impactsDomain

      public boolean impactsDomain(D domain)
      Determine if a domain is impacted by a condition. A domain is impacted by a condition if and only if the domain is associated with the condition by being one of the condition's observers.
      Parameters:
      domain - the domain
      Returns:
      true if impacted; false otherwise
    • hasObserver

      public boolean hasObserver(CondObserver observer)
      Determine if a condition observer observes this condition.
      Parameters:
      observer - the observer
      Returns:
      true if the observer monitors this condition; false otherwise
    • domainSet

      public Set<D> domainSet()
      Get a set of domains associated with a condition. This set is a subset of the condition's observers.
      Returns:
      a set of conditions
    • observerCollection

      public Collection<SimObject> observerCollection()
      Get a collection of simulation objects associated with a condition While formally this method returns a collection, the collection is actually a set (there are no duplicate entries).
      Returns:
      a collection of conditions
    • notifyObservers

      public void notifyObservers()
      Notify observers that a condition may have changed. Normally this must be called explicitly, so that multiple of conditions can be changed before domains are notified .
    • completeNotification

      public void completeNotification()
      Indicate that the current batch of condition-change notifications is complete. When condition changes are queued, this will flush the queue, sending the notifications to various domain members. It should always be called after a call to notifyDomains in case notification queuing is enabled for a domain.
    • printConfiguration

      public void printConfiguration(String iPrefix, String prefix, boolean printName, PrintWriter out)
      Print this simulation object's configuration. Documentation for the use of this method is provided by the documentation for the SimObject method SimObject.printConfiguration(String,String,boolean,PrintWriter). When the thirs argument has a value of true, the object name and class name will be printed in a standard format with its indentation provided by the iPrefix argument. In addition, the configuration that is printed includes the following items.

      Defined in GenericCondition:

      • the observers for this condition.
      Overrides:
      printConfiguration in class GenericSimObject<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>>
      Parameters:
      prefix - a prefix string (typically whitespace) to put at the start of each line other than the initial line that is printed when printName is true
      printName - requests printing the name of an object
      out - the output print writer
      iPrefix - the prefix to use for an initial line when printName is true with null treated as an empty string
    • 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