- All Implemented Interfaces:
Comparable<Domain>
,CondObserver<Condition,
,Domain> NamedObjectOps
The operations provided in this class are the ones needed to associate a domain with domain members and conditions, and to forward notifications when a condition changes. Domain members represent actors. By default, each actor has a unique domain member, but actors can be configured so that multiple actors share a domain member, which reduces memory use when a number of actors have identical domain memberships.
A domain can be configured as a communication domain. In this case
it can be used to determine if a path exists between a source and
destination, and the corresponding delays and message filters. The method
setMessageForwardingInfo(MsgForwardingInfo)
associates
a domain with an object that can determine the appropriate delays and
message filters. When configured as a communication domain, a domain
must call one of the configureAsCommunicationDomain methods. These
tag the domain with an instance of
CommDomainType
to indicate the type
of the communication domain. Subclasses determine how this tag should
be used. On may optionally provide a set of additional instances of
CommDomainType. The use of these is also left to subclasses.
Note: this class overrides/replaces methods associated with MsgForwardingInfo so that one does not have to use similar types from the org.bzdev.drama.generic package directly.
-
Constructor Summary
ConstructorsConstructorDescriptionDomain
(DramaSimulation sim) Constructor for uninterned domains.Domain
(DramaSimulation sim, int priority) Constructor for uninterned domains with priority.Domain
(DramaSimulation sim, String name) Constructor for named and interned domains.Domain
(DramaSimulation sim, String name, boolean intern) Constructor.Domain
(DramaSimulation sim, String name, boolean intern, int priority) Constructor with priority.Domain
(DramaSimulation sim, String name, boolean intern, Domain parent) Constructor with parent.Domain
(DramaSimulation sim, String name, boolean intern, Domain parent, int priority) Constructor with priority and parent.Domain
(DramaSimulation sim, String name, int priority) Constructor for named and interned domains with priority.Domain
(DramaSimulation sim, String name, Domain parent) Constructor for named and interned domains with parent.Domain
(DramaSimulation sim, String name, Domain parent, int priority) Constructor for named and interned domain with parent and priority.Domain
(DramaSimulation sim, Domain parent) Constructor for uninterned domain with parent.Domain
(DramaSimulation sim, Domain parent, int priority) Constructor for uninterned domains with parent and priority. -
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.protected MsgForwardingInfo
Get the class determining delays and message filters associated with this domain.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.void
Configure message-forwarding parameters.Methods inherited from class org.bzdev.drama.generic.GenericDomain
actorSet, actorSetSize, addCommDomainTypeSet, addCondition, canDelete, communicationMatch, communicationMatch, communicationMatch, communicationMatch, communicationMatch, communicationMatch, communicationMatch, communicationMatchByDomain, communicationMatchByDomain, communicationMatchByDomain, communicationMatchByDomain, communicationMatchByDomainAncestor, communicationMatchByDomainAncestor, communicationMatchByDomainAncestor, communicationMatchByDomainAncestor, compareTo, conditionSet, configureAsCommunicationDomain, configureAsCommunicationDomain, configureAsCommunicationDomain, containsActor, containsDomainMember, containsGroup, createCommDomainInfo, domainMemberSet, getCommDomainType, getCommDomainTypeSet, getConditionChangeQMode, getCondObserverImpl, getDelay, getDelay, getDelay, getDelay, getMessageFilter, getMessageFilter, getMessageFilter, getMessageFilter, getMFI, getParent, getPriority, groupSet, groupSetSize, hasCondition, isCommunicationDomain, onChildAdd, onChildRemove, onDelete, onJoinedDomain, onJoinedDomain, onLeftDomain, onLeftDomain, printConfiguration, removeCondition, setConditionChangeQMode, setMessageForwardingInfo
Methods inherited from class org.bzdev.drama.generic.GenericTaskObject
cancelDefaultCall, cancelDefaultTask, defaultCall, defaultTask, scheduleDefaultCall, scheduleDefaultTask, scheduleDefaultTask
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
-
Domain
Constructor.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedintern
- 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
-
Domain
public Domain(DramaSimulation sim, String name, boolean intern, Domain parent) throws IllegalArgumentException Constructor with parent.- Parameters:
sim
- the simulationname
- the domain's name; null for an automatically generated nameintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.parent
- the parent domain- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
public Domain(DramaSimulation sim, String name, boolean intern, int priority) throws IllegalArgumentException Constructor with priority.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.priority
- determines the search order for domains (lowest priorities appear first)- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
public Domain(DramaSimulation sim, String name, boolean intern, Domain parent, int priority) throws IllegalArgumentException Constructor with priority and parent.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedintern
- true if the object can be looked up by using the methods inSimulation
; false otherwise.parent
- the parent domainpriority
- determines the search order for domains (lowest priorities appear first)- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
Constructor for uninterned domains.- Parameters:
sim
- the simulation
-
Domain
Constructor for uninterned domain with parent.- Parameters:
sim
- the simulationparent
- the parent domain
-
Domain
Constructor for uninterned domains with priority.- Parameters:
sim
- the simulationpriority
- determines the search order for domains (lowest priorities appear first)
-
Domain
Constructor for uninterned domains with parent and priority.- Parameters:
sim
- the simulationparent
- the parent domainpriority
- determines the search order for domains (lowest priorities appear first)
-
Domain
Constructor for named and interned domains.- Parameters:
sim
- the simulationname
- the domain's name; null if generated- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
Constructor for named and interned domains with parent.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedparent
- the parent domain- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
Constructor for named and interned domains with priority.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedpriority
- determines the search order for domains (lowest priorities appear first)- Throws:
IllegalArgumentException
- typically means a name is already in use
-
Domain
public Domain(DramaSimulation sim, String name, Domain parent, int priority) throws IllegalArgumentException Constructor for named and interned domain with parent and priority.- Parameters:
sim
- the simulationname
- the domain's name; null if generatedparent
- the parent domainpriority
- determines the search order for domains (lowest priorities appear first)- Throws:
IllegalArgumentException
- typically means a name is already in use
-
-
Method Details
-
setMessageForwardingInfo
Configure message-forwarding parameters.- Parameters:
info
- an object providing the delay and message filter that a domain will use for a given message source and destination; null will restore the default
-
getMsgForwardingInfo
Get the class determining delays and message filters associated with this domain.- Returns:
- an object providing delays and message filters associated with this domain
-
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
-