java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.drama.generic.GenericSimObject<S,A,C,D,DM,F,G>
org.bzdev.drama.generic.GenericDomainMember<DramaSimulation,Actor,Condition,Domain,DomainMember,DramaFactory,Group>
org.bzdev.drama.DomainMember
- All Implemented Interfaces:
NamedObjectOps
public class DomainMember
extends GenericDomainMember<DramaSimulation,Actor,Condition,Domain,DomainMember,DramaFactory,Group>
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 Summary
ConstructorsConstructorDescriptionConstructor for unshared domain members.DomainMember
(DramaSimulation sim, String name) Constructor for interned-and-named shared domain members.DomainMember
(DramaSimulation sim, String name, boolean intern) Constructor for shared domain members. -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.Methods inherited from class org.bzdev.drama.generic.GenericDomainMember
canDelete, domainSet, getChildDomains, getDomains, inDomain, isShared, joinDomain, joinDomain, leaveDomain, onDelete, printConfiguration
Methods inherited from class org.bzdev.drama.generic.GenericSimObject
getSimulation, printState
Methods inherited from class org.bzdev.devqsim.SimObject
addSimulationListener, addTraceSet, bindCallable, bindCallable, bindCallable, bindCallable, bindRunnable, bindRunnable, bindRunnable, bindRunnable, callableObject, callableScript, callScriptFunction, callScriptMethod, clearTraceSets, evalScript, getEventListenerList, getScriptObject, getTraceSets, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printState, printState, printState, printState, printState, printState, putScriptObject, removeSimulationListener, removeTraceSet, runnableObject, runnableScript, scheduleCall, scheduleCall, scheduleCall, scheduleCall, scheduleCallObject, scheduleScript, scheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTaskObject, scheduleTaskScript, startImmediateTask, startImmediateTask, trace, trace, unscheduledTaskThread, unscheduledTaskThread, update, update, usesTraceSet
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.bzdev.obnaming.NamedObjectOps
delete, deletePending, getName, isDeleted, isInterned
-
Constructor Details
-
DomainMember
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 simulationname
- the name of this domain member; null for an automatically generated nameintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.- Throws:
IllegalArgumentException
- typically means a name is already in use
-
DomainMember
Constructor for interned-and-named shared domain members.- Parameters:
sim
- the simulationname
- the name of this domain member; null if generated- Throws:
IllegalArgumentException
- typically means a name is already in use
-
-
Method Details
-
clone
Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.- Overrides:
clone
in classObject
- 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 interfaceNamedObjectOps
- Returns:
- true if the object is interned; false if not
-
getObjectNamer
Get the object namer for a named object.- Returns:
- the object namer for this named object
-
getName
Get an object's name.- Specified by:
getName
in interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- 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 interfaceNamedObjectOps
- Returns:
- true if deletion is pending; false otherwise
-