Class GenericDomainMember<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>>
- All Implemented Interfaces:
NamedObjectOps
- Direct Known Subclasses:
DomainMember
Generally, there will be a class hierarchy of abstract factories matching the class hierarchy for subclasses of the class a factory creates, each responsible for providing parameters for the corresponding subclass. In addition, there will typically be a factory that is not abstract for each class that can be created.
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
ConstructorsConstructorDescriptionGenericDomainMember
(S sim) Constructor for unshared domain members.GenericDomainMember
(S sim, String name, boolean intern) Constructor for shared domain members. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine if this simulation object can be deleted.protected 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.Get a set of the domains the current domain member is in.getChildDomains
(D ancestor) Get a set of the domains that the current domain member is in with a common ancestor.Get a set of the domains that the current domain member is in.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.boolean
Determine if in a domain.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.boolean
isShared()
Determine if a domain member is a shared domain member.boolean
joinDomain
(D d) Join a domain.boolean
joinDomain
(D d, boolean trackCondition) Join a domain, optionally tracking conditions that impact that domain.boolean
leaveDomain
(D d) Leave a domain.protected void
onDelete()
Complete the actions necessary to delete a named object.void
printConfiguration
(String iPrefix, String prefix, boolean printName, PrintWriter out) Print this simulation object's configuration.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
-
GenericDomainMember
Constructor for unshared domain members.- Parameters:
sim
- the simulation
-
GenericDomainMember
Constructor for shared domain members.- Parameters:
sim
- the simulationname
- the name of this domain memberintern
- 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
-
-
Method Details
-
canDelete
public boolean canDelete()Determine if this simulation object can be deleted. An GenericDomainMember can be deleted if the method delete has not been called and if it is not a shared domain member- Specified by:
canDelete
in interfaceNamedObjectOps
- Returns:
- true if this object can be deleted; false otherwise
-
onDelete
protected void onDelete()Complete the actions necessary to delete a named object. A subclass that overrides this method must call super.onDelete() at some point to complete the object deletion. This may not be within the onDelete method of the subclass if the deletion must be delayed for some reason (e.g., until some processing that is in progress has been completed). Once called, the object will be removed from the object-namer's tables and the object will be marked as deleted, so in general cleanup actions by a subclass should occur before it calls super.onDelete(). -
getDomains
Get a set of the domains that the current domain member is in. The set is ordered based on domain-specific criteria. This differs from domainSet in that the set returned is not wrapped by an unmodifiable sorted set.- Returns:
- a set of domains.
-
getChildDomains
Get a set of the domains that the current domain member is in with a common ancestor. The iterator for the returned set will return domains in the order set by domain-specific criteria. The domains in the set are restricted to communication domains, and all domains leading to the common ancestor must be communication domains.- Parameters:
ancestor
- the ancestor domain- Returns:
- a set of ancestor domains
-
joinDomain
Join a domain.- Parameters:
d
- the domain- Returns:
- true on success; false on failure, including having already joined
-
joinDomain
Join a domain, optionally tracking conditions that impact that domain. For a shared domain member, if an actor using that domain member has independently joined a domain,joinDomain(...)
will fail and returnfalse
.- Parameters:
d
- the domaintrackCondition
- true if conditions should be tracked; false otherwise- Returns:
- true on success; false on failure, including having already joined
-
leaveDomain
Leave a domain.- Parameters:
d
- the domain- Returns:
- true on success; false on failure
-
inDomain
Determine if in a domain.- Parameters:
d
- the domain- Returns:
- true if in domain d; false otherwise
-
domainSet
Get a set of the domains the current domain member is in.- Returns:
- the domain set.
-
printConfiguration
Print this simulation object's configuration. Documentation for the use of this method is provided by the documentation for theSimObject
methodSimObject.printConfiguration(String,String,boolean,PrintWriter)
. When the thirs argument has a value of true, the object name and class name will be printed in a standard format with its indentation provided by the iPrefix argument. In addition, the configuration that is printed includes the following items.Defined in
GenericDomainMember
:- the domains this domain member has joined.
- the actors that this domain member handles.
- Overrides:
printConfiguration
in classGenericSimObject<S extends GenericSimulation<S,
A, C, D, DM, F, G>, A extends GenericActor<S, A, C, D, DM, F, G>, C extends GenericCondition<S, A, C, D, DM, F, G>, D extends GenericDomain<S, A, C, D, DM, F, G>, DM extends GenericDomainMember<S, A, C, D, DM, F, G>, F extends GenericFactory<S, A, C, D, DM, F, G>, G extends GenericGroup<S, A, C, D, DM, F, G>> - Parameters:
iPrefix
- the prefix to use for an initial line when printName is true with null treated as an empty stringprefix
- a prefix string (typically whitespace) to put at the start of each line other than the initial line that is printed when printName is trueprintName
- requests printing the name of an objectout
- the output print writer
-
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