Class Domain

All Implemented Interfaces:
Comparable<Domain>, CondObserver<Condition,Domain>, NamedObjectOps

Domain class. Domains are collections of actors and also are condition observers so that domains are notified when the conditions they are interested in change.

The operations provided in this class are the ones needed to associate a domain with domain members and conditions, and to forward notifications when a condition changes. Domain members represent actors. By default, each actor has a unique domain member, but actors can be configured so that multiple actors share a domain member, which reduces memory use when a number of actors have identical domain memberships.

A domain can be configured as a communication domain. In this case it can be used to determine if a path exists between a source and destination, and the corresponding delays and message filters. The method setMessageForwardingInfo(MsgForwardingInfo) associates a domain with an object that can determine the appropriate delays and message filters. When configured as a communication domain, a domain must call one of the configureAsCommunicationDomain methods. These tag the domain with an instance of CommDomainType to indicate the type of the communication domain. Subclasses determine how this tag should be used. On may optionally provide a set of additional instances of CommDomainType. The use of these is also left to subclasses.

Note: this class overrides/replaces methods associated with MsgForwardingInfo so that one does not have to use similar types from the org.bzdev.drama.generic package directly.

  • Constructor Details

    • Domain

      public Domain(DramaSimulation sim, String name, boolean intern) throws IllegalArgumentException
      Constructor.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      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
    • Domain

      public Domain(DramaSimulation sim, String name, boolean intern, Domain parent) throws IllegalArgumentException
      Constructor with parent.
      Parameters:
      sim - the simulation
      name - the domain's name; null for an automatically generated name
      intern - true if the object can be looked up by using the methods in Simulation; false otherwise.
      parent - the parent domain
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim, String name, boolean intern, int priority) throws IllegalArgumentException
      Constructor with priority.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      intern - true if the object can be looked up by using the methods in Simulation; false otherwise.
      priority - determines the search order for domains (lowest priorities appear first)
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim, String name, boolean intern, Domain parent, int priority) throws IllegalArgumentException
      Constructor with priority and parent.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      intern - true if the object can be looked up by using the methods in Simulation; false otherwise.
      parent - the parent domain
      priority - determines the search order for domains (lowest priorities appear first)
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim)
      Constructor for uninterned domains.
      Parameters:
      sim - the simulation
    • Domain

      public Domain(DramaSimulation sim, Domain parent)
      Constructor for uninterned domain with parent.
      Parameters:
      sim - the simulation
      parent - the parent domain
    • Domain

      public Domain(DramaSimulation sim, int priority)
      Constructor for uninterned domains with priority.
      Parameters:
      sim - the simulation
      priority - determines the search order for domains (lowest priorities appear first)
    • Domain

      public Domain(DramaSimulation sim, Domain parent, int priority)
      Constructor for uninterned domains with parent and priority.
      Parameters:
      sim - the simulation
      parent - the parent domain
      priority - determines the search order for domains (lowest priorities appear first)
    • Domain

      public Domain(DramaSimulation sim, String name) throws IllegalArgumentException
      Constructor for named and interned domains.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim, String name, Domain parent) throws IllegalArgumentException
      Constructor for named and interned domains with parent.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      parent - the parent domain
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim, String name, int priority) throws IllegalArgumentException
      Constructor for named and interned domains with priority.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      priority - determines the search order for domains (lowest priorities appear first)
      Throws:
      IllegalArgumentException - typically means a name is already in use
    • Domain

      public Domain(DramaSimulation sim, String name, Domain parent, int priority) throws IllegalArgumentException
      Constructor for named and interned domain with parent and priority.
      Parameters:
      sim - the simulation
      name - the domain's name; null if generated
      parent - the parent domain
      priority - determines the search order for domains (lowest priorities appear first)
      Throws:
      IllegalArgumentException - typically means a name is already in use
  • Method Details

    • setMessageForwardingInfo

      public void setMessageForwardingInfo(MsgForwardingInfo info)
      Configure message-forwarding parameters.
      Parameters:
      info - an object providing the delay and message filter that a domain will use for a given message source and destination; null will restore the default
    • getMsgForwardingInfo

      protected MsgForwardingInfo getMsgForwardingInfo()
      Get the class determining delays and message filters associated with this domain.
      Returns:
      an object providing delays and message filters associated with this domain
    • 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