Class GenericCondition<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:
Condition
Conditions can be used for a variety of purposes, including turning on or off debugging for all the actors associated with a given domain. The simplest conditions simply provide a value.
When a condition changes its state, the object that changed the state is expected to call notifyObservers() followed by completeNotification(). The use of two methods allows objects to queue up multiple notifications and apply them at once.
As a general rule, it is preferable to send as few notifications as possible. For example, if a condition represents a value that is changing with time, one might represent the condition by a value at some time and the rate of change, sending notifications only when new values or rates of change are needed.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
GenericCondition
(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.void
Indicate that the current batch of condition-change notifications is complete.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.Get a set of domains associated with a condition.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.boolean
hasObserver
(CondObserver observer) Determine if a condition observer observes this condition.boolean
impactsDomain
(D domain) Determine if a domain is impacted by a condition.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.void
Notify observers that a condition may have changed.Get a collection of simulation objects associated with a condition While formally this method returns a collection, the collection is actually a set (there are no duplicate entries).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.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
canDelete, delete, deletePending, getName, isDeleted, isInterned
-
Constructor Details
-
GenericCondition
Constructor.- Parameters:
sim
- the simulationname
- the name of the conditionintern
- 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
-
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().- Overrides:
onDelete
in classGenericTaskObject<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>>
-
impactsDomain
Determine if a domain is impacted by a condition. A domain is impacted by a condition if and only if the domain is associated with the condition by being one of the condition's observers.- Parameters:
domain
- the domain- Returns:
- true if impacted; false otherwise
-
hasObserver
Determine if a condition observer observes this condition.- Parameters:
observer
- the observer- Returns:
- true if the observer monitors this condition; false otherwise
-
domainSet
Get a set of domains associated with a condition. This set is a subset of the condition's observers.- Returns:
- a set of conditions
-
observerCollection
Get a collection of simulation objects associated with a condition While formally this method returns a collection, the collection is actually a set (there are no duplicate entries).- Returns:
- a collection of conditions
-
notifyObservers
public void notifyObservers()Notify observers that a condition may have changed. Normally this must be called explicitly, so that multiple of conditions can be changed before domains are notified . -
completeNotification
public void completeNotification()Indicate that the current batch of condition-change notifications is complete. When condition changes are queued, this will flush the queue, sending the notifications to various domain members. It should always be called after a call to notifyDomains in case notification queuing is enabled for a domain. -
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
GenericCondition
:- the observers for this condition.
- 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:
prefix
- 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 writeriPrefix
- the prefix to use for an initial line when printName is true with null treated as an empty string
-
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
-