Class GenericMsgFrwdngInfo<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:
MsgForwardingInfo
GenericDomain
contains methods for
finding delays and message filters for messages sent between actors
and groups for cases in which the delay is not given explicitly.
The source and destination of a message, however, may not be in the
same domain. If not, parent domains are checked until one finds a
source domain and a destination domain with a common parent, and
with all three domains, plus any in between, constrained to being
communication domains, possibly with a set of possible
communication-domain types specified. These domains are used to
compute the delay and any applicable message filters.
Instances of GenericMsgFrwdngInfo are used to allow each domain in
the path between a source and destination to provide a contribution
to the delay and message filter. This is done by summing individual
delays and by creating instances of
CompoundMessageFilter
, which allows
multiple message filters to be applied in sequence.
As an example. suppose we have 8 domains, with the domain "topdomain" not having a parent domain. the domains "domain" and "subdomain5" have "topdomain" as their parents. The domain "subdomain6" has "subdomain5" as its parent. In addition, the domains "subdomain1", "subdomain2", subdomain3", and "subdomain4" have "domain" as their parent. Also suppose that actor "a1" joins "subdomain1", actor "a2" joins "subdomain3", actor "a3"joins "subdomain3", actor a4 joins "subdomain4", actor "a6" joins "subdomain6", actor "adom" joins "domain", and actor atop joins "topdomain". Then
- if a2 sends a message to a3 :
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain3 a2 a3 - if a1 sends a message to adom:
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain1 a1 domain domain subdomain1 adom - if a1 sends a message to a2 :
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain1 a1 domain domain subdomain1 subdomain3 subdomain3 domain a2 - if a1 sends a message to atop :
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain1 a1 domain domain subdomain1 topdomain topdomain domain atop - if a1 sends a message to a5:
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain1 a1 domain domain subdomain1topdomain topdomaindomain subdomain5 subdomain5 topdomain a5 - if a1 sends a message to a6:
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumentsubdomain1 a1 domain domain subdomain1 topdomain topdomain domain subdomain5 subdomain5 domain subdomain6 subdomain6 subdomain5 a6 - if atop sends a message to a5:
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumenttodomain atop subdomain5 subdomain5 topdomain a5 - if atop sends a message to a6:
localDelay
First ArgumentlocalDelay
Second ArgumentlocalDelay
Fourth Argumenttopdomain atop subdomain5 subdomain5 topdomain subdomain6 subdomain6 subdomain5 a6
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
GenericMsgFrwdngInfo
(S sim, String name, boolean intern) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine if this named 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.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.protected long
localDelay
(D domain, A src, Object msg, A dest) Get the contribution of a domain to the total delay for a message, source actor, and destination actor.protected long
localDelay
(D domain, A src, Object msg, D next) Get the contribution of a domain to the total delay for a message, source actor, and domain that will forward a messageprotected long
localDelay
(D domain, A src, Object msg, G dest) Get the contribution of a domain to the total delay for a message, source actor, and destination group.protected long
localDelay
(D domain, D src, Object msg, A dest) Get the contribution of a domain to the total delay for a message, a previous domain and the destination actor.protected long
localDelay
(D domain, D src, Object msg, D next) Get the contribution of a domain to the total delay for a message, a previous domain and the next domain.protected long
localDelay
(D domain, D src, Object msg, G dest) Get the contribution of a domain to the total delay for a message, a previous domain and the destination actor.protected long
localDelay
(D domain, G src, Object msg, A dest) Get the contribution of a domain to the total delay for a message, source group, and destination actor.protected long
localDelay
(D domain, G src, Object msg, D next) Get the contribution of a domain to the total delay for a message, source group, and domain that will forward a messageprotected long
localDelay
(D domain, G src, Object msg, G dest) Get the contribution of a domain to the total delay for a message, source group, and destination group.protected MessageFilter
localMessageFilter
(D domain, A src, Object msg, A dest) Get the message filter provided by a domain for a message, a source actor and a destination actor.protected MessageFilter
localMessageFilter
(D domain, A src, Object msg, D next) Get the message filter provided by a domain for a message, a source actor and a domain that will forward the message.protected MessageFilter
localMessageFilter
(D domain, A src, Object msg, G dest) Get the message filter provided by a domain for a message, a source actor and a destination group.protected MessageFilter
localMessageFilter
(D domain, D src, Object msg, A dest) Get the message filter provided by a domain for a message, a domain that has forwarded the message and a destination actor.protected MessageFilter
localMessageFilter
(D domain, D src, Object msg, D next) Get the message filter provided by a domain for a message, a domain that has forwarded the message and a domain that will forward the messageprotected MessageFilter
localMessageFilter
(D domain, D src, Object msg, G dest) Get the message filter provided by a domain for a message, a domain that has forwarded the message and a destination group.protected MessageFilter
localMessageFilter
(D domain, G src, Object msg, A dest) Get the message filter provided by a domain for a message, a source group and a destination actor.protected MessageFilter
localMessageFilter
(D domain, G src, Object msg, D next) Get the message filter provided by a domain for a message, a source group and a domain that will forward the message.protected MessageFilter
localMessageFilter
(D domain, G src, Object msg, G dest) Get the message filter provided by a domain for a message, a source group and a destination group.Methods inherited from class org.bzdev.drama.generic.GenericSimObject
getSimulation, printConfiguration, 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, onDelete, 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
canDelete, delete, deletePending, getName, isDeleted, isInterned
-
Constructor Details
-
GenericMsgFrwdngInfo
Constructor.- Parameters:
sim
- the simulationname
- the name of the belief; null if one should be chosenintern
- 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
-
localDelay
Get the contribution of a domain to the total delay for a message, source actor, and destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, source actor, and destination group.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, source actor, and domain that will forward a message- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagenext
- the domain that will forward the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, source group, and destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, source group, and destination group.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, source group, and domain that will forward a message- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagenext
- the domain that will forward the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, a previous domain and the destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, a previous domain and the destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagedest
- the destination for the message- Returns:
- the contribution of the domain to the delay
-
localDelay
Get the contribution of a domain to the total delay for a message, a previous domain and the next domain.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagenext
- the domain tat will forward the message- Returns:
- the contribution of the domain to the delay
-
localMessageFilter
Get the message filter provided by a domain for a message, a source actor and a destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a source actor and a destination group.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a source actor and a domain that will forward the message.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagenext
- the domain that will forward the message message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a source group and a destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a source group and a destination group.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a source group and a domain that will forward the message.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the source for the messagemsg
- the messagenext
- the domain that will forward the message message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a domain that has forwarded the message and a destination actor.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a domain that has forwarded the message and a destination group.- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagedest
- the destination for the message- Returns:
- the message filter
-
localMessageFilter
Get the message filter provided by a domain for a message, a domain that has forwarded the message and a domain that will forward the message- Parameters:
domain
- the domain used to determine a contribution to the delaysrc
- the domain that has forwarded the messagemsg
- the messagenext
- the domain that will forward the message- Returns:
- the message filter
-
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
-
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 interfaceNamedObjectOps
- 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 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
-