Class Actor

All Implemented Interfaces:
CondObserver<Condition,Actor>, NamedObjectOps

Top-level basic-simulation class for actors. Actors are task objects that can send and receive messages. They can be members of domains, and when joining a domain, can request to be notified when a condition changes.
  • Constructor Details

  • Method Details

    • doReceive

      protected void doReceive(Object message, Actor source, boolean wereQueued)
      Respond to a message. Subclasses should either implement this method to perform any necessary processing in response to a message or use dynamic methods. Dynamic Method processing is enabled for only the first argument, and an implementation of a dynamic method must use "org.bzdev.drama.DoReceive" in its @DMethodImpl annotation. Such a subclass must be annotated with a @ DMethodContext annotation whose helper element's value is the string "org.bzdev.drama.DoReceive" and whose localHelper element is the name of the "helper" class that will be generated. A static block should call the local helper's register() method (one class loader will do this automatically, but that class loader may not be installed so it is better to add this code explicitly).

      If multiple @DMethodContext annotations are needed, these should be place in a @DMethodContexts annotation (whose value is an array of @DMethodContext).

      Overrides:
      doReceive in class GenericActor<DramaSimulation,Actor,Condition,Domain,DomainMember,DramaFactory,Group>
      Parameters:
      message - the message just received
      source - the actor that originated the message
      wereQueued - true if the message was queued; false otherwise
      See Also:
    • onConditionChange

      protected void onConditionChange(Condition c, ConditionMode mode, SimObject source)
      Respond to a change in conditions Subclasses should either implement this method to perform any necessary processing in response to a condition change or use dynamic methods. When dynamic methods are used, the implementation of a dynamic method must use "org.bzdev.drama.OnConditionChange"in its @DMethodImpl annotation. A subclass using the @DMethodImpl annotation must be annotated with a @DMethodContext annotation whose helper element's value is the string "org.bzdev.drama.OnConditionChange" and whose localHelper element is the name of the "helper" class that will be generated. A static block should call the local helper's register() method (one class loader will do this automatically, but that class loader may not be installed so it is better to add this code explicitly).

      If multiple @DMethodContext annotations are needed, these should be place in a @DMethodContexts annotation (whose value is an array of @DMethodContext).

      Finally, dynamic-method processing is applied only to the first argument. The third argument (source) depends on the condition mode:

      • for a mode of CONDITION_DELETED, the third argument is the condition that was deleted (the same as the first argument).
      • for a mode of DOMAIN_ADDED_CONDITION, the third argument is the domain that added the condition.
      • for a mode of DOMAIN_REMOVED_CONDITION, the third argument is the domain that added the condition.
      • for a mode of OBSERVER_ADDED_CONDITION, the third argument is the condition observer (e.g., an actor or group) that added a condition.
      • for a mode of OBSERVER_REMOVED_CONDITION, the third argument is the condition observer (e.g., an actor or group) that added a condition.
      • for a mode of OBSERVER_JOINED_DOMAIN, the third argument is the domain an actor left
      • for a mode of OBSERVER_LEFT_DOMAIN, the third argument is the domain that an actor left.
      • for a mode of OBSERVER_NOTIFIED, the third argument is the condition that was changed (the same as the first argument).
      The default behavior (unless there is a dynamic method implemented for specific subclasses of the first argument) is to do nothing.
      Overrides:
      onConditionChange in class GenericActor<DramaSimulation,Actor,Condition,Domain,DomainMember,DramaFactory,Group>
      Parameters:
      c - the condition that changed
      mode - the mode for the condition
      source - the object responsible for the change
      See Also:
    • 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