Class DomainMember

All Implemented Interfaces:
NamedObjectOps

DomainMember class. Domain members are used by actors for domain membership. By default, each actor has a unique domain member, but it is possible to explicitly configure an actor so that its domain member object is shared with other actors. This saves on memory when multiple actors have identical domain memberships and are also in multiple domains. It also simplifies setting up a simulation in these cases.

At any point, an actor can replace a shared domain member with a per-actor domain member, but it that is done, all of its domain memberships must be reconfigured.

  • Constructor Details

    • DomainMember

      public DomainMember(DramaSimulation sim)
      Constructor for unshared domain members.
      Parameters:
      sim - the simulation
    • DomainMember

      public DomainMember(DramaSimulation sim, String name, boolean intern) throws IllegalArgumentException
      Constructor for shared domain members.
      Parameters:
      sim - the simulation
      name - the name of this domain member; 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
    • DomainMember

      public DomainMember(DramaSimulation sim, String name) throws IllegalArgumentException
      Constructor for interned-and-named shared domain members.
      Parameters:
      sim - the simulation
      name - the name of this domain member; null if generated
      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