Class MsgForwardingInfo

All Implemented Interfaces:
NamedObjectOps

Class providing delays and message filters. The class Domain contains methods for finding delays and message filters for messages sent between actors and groups for cases in which the delay is not given explicitly. The source and destination of a message, however, may not be in the same domain. If not, parent domains are checked until one finds a source domain and a destination domain with a common parent, and with all three domains, plus any in between, constrained to being communication domains, possibly with a set of possible communication-domain types specified. These domains are used to compute the delay and any applicable message filters.

Instances of MsgFrwdngInfo are used to allow each domain in the path between a source and destination to provide a contribution to the delay and message filter. This is done by summing individual delays and by creating instances of CompoundMessageFilter, which allows multiple message filters to be applied in sequence.

As an example. suppose we have 8 domains, with the domain "topdomain" not having a parent domain. the domains "domain" and "subdomain5" have "topdomain" as their parents. The domain "subdomain6" has "subdomain5" as its parent. In addition, the domains "subdomain1", "subdomain2", subdomain3", and "subdomain4" have "domain" as their parent. Also suppose that actor "a1" joins "subdomain1", actor "a2" joins "subdomain3", actor "a3"joins "subdomain3", actor a4 joins "subdomain4", actor "a6" joins "subdomain6", actor "adom" joins "domain", and actor atop joins "topdomain". Then

  • if a2 sends a message to a3 :
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain3a2a3
  • if a1 sends a message to adom:
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain1a1domain
    domainsubdomain1adom
  • if a1 sends a message to a2 :
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain1a1domain
    domainsubdomain1subdomain3
    subdomain3domaina2
  • if a1 sends a message to atop :
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain1a1domain
    domainsubdomain1topdomain
    topdomaindomainatop
  • if a1 sends a message to a5:
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain1a1domain
    domainsubdomain1topdomain
    topdomaindomainsubdomain5
    subdomain5topdomaina5
  • if a1 sends a message to a6:
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    subdomain1a1domain
    domainsubdomain1topdomain
    topdomaindomainsubdomain5
    subdomain5domainsubdomain6
    subdomain6subdomain5a6
  • if atop sends a message to a5:
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    todomainatopsubdomain5
    subdomain5topdomaina5
  • if atop sends a message to a6:
     
    localDelay
    First Argument
    localDelay
    Second Argument
    localDelay
    Fourth Argument
    topdomainatopsubdomain5
    subdomain5topdomainsubdomain6
    subdomain6subdomain5a6
The method getMessageFilter is handled similarly, with calls to localMessageFilter instead of localDelay. While the examples just use actor, groups are treated the same way.
See Also:
  • Constructor Details

    • MsgForwardingInfo

      public MsgForwardingInfo(DramaSimulation sim, String name, boolean intern) throws IllegalArgumentException
      Constructor.
      Parameters:
      sim - the simulation
      name - the name of this 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
  • 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
    • 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