Module org.bzdev.drama

Package org.bzdev.drama.generic

Class GenericTaskObject<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>>

java.lang.Object

org.bzdev.devqsim.SimObject

org.bzdev.drama.generic.GenericSimObject<S,A,C,D,DM,F,G>

org.bzdev.drama.generic.GenericTaskObject<S,A,C,D,DM,F,G>

All Implemented Interfaces:

NamedObjectOps

Direct Known Subclasses:

AbstractTaskObject, GenericCondition, GenericDomain, MessageRecipient

public abstract class GenericTaskObject<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>>
extends GenericSimObject<S,A,C,D,DM,F,G>

Superclass for those classes that need standard methods for scheduling a specific task or method call. Subclasses can provide implementations of the methods defaultCall() and defaultTask() to provide default code to either call or run in a task thread. Methods allow these to be scheduled and canceled.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericTaskObject(S sim, String name, boolean intern)	Constructor for task objects that are interned in the simulation tables.

Method Summary

Modifier and Type	Method	Description
protected void	cancelDefaultCall()	Cancel a scheduled call to the defaultCall method.
protected void	cancelDefaultTask()	Cancel the default task.
boolean	canDelete()	Determine if this named object can be deleted.
protected Object	clone()	Creates and returns a copy of this object.
protected void	defaultCall()	Respond to a scheduled event.
protected void	defaultTask()	The method to call when the default task is scheduled.
final boolean	delete()	Delete an object.
final boolean	deletePending()	Determine if an object is being deleted.
final String	getName()	Get an object's name.
protected Simulation	getObjectNamer()	Get the object namer for a named object.
final boolean	isDeleted()	Determine if an object has been deleted.
boolean	isInterned()	Determine if an object is interned in a object namer's tables.
protected void	onDelete()	Complete the actions necessary to delete a named object.
protected void	scheduleDefaultCall(long delay)	Schedule an event to trigger a call to defaultCall.
protected void	scheduleDefaultTask()	Schedule the default task for immediate execution.
protected void	scheduleDefaultTask(long delay)	Schedule the default task for future execution.

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, 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

GenericTaskObject

protected GenericTaskObject(S sim,
 String name,
 boolean intern)
                     throws IllegalArgumentException

Constructor for task objects that are interned in the simulation tables.

Parameters:

sim - the simulation

name - the name of the belief; null if one should be chosen

intern - true if the object can be looked up by using the methods in Simulation; false otherwise.

Throws:

IllegalArgumentException - typically means a name is already in use

Method Details

scheduleDefaultCall

protected void scheduleDefaultCall(long delay)
                            throws IllegalStateException

Schedule an event to trigger a call to defaultCall.

Parameters:

delay - the number of time units to wait past the current time

Throws:

IllegalStateException - a call was already scheduled

cancelDefaultCall

protected void cancelDefaultCall()

Cancel a scheduled call to the defaultCall method.

defaultTask

protected void defaultTask()

The method to call when the default task is scheduled. A default task differs from a default call in that a default task can be suspended or paused for a given amount of simulation time, or can be placed on a queue.

scheduleDefaultTask

protected void scheduleDefaultTask()
                            throws InterruptedException,
IllegalStateException

Schedule the default task for immediate execution.

Throws:

InterruptedException - execution was interrupted

IllegalStateException

scheduleDefaultTask

protected void scheduleDefaultTask(long delay)
                            throws InterruptedException,
IllegalStateException

Schedule the default task for future execution.

Parameters:

delay - the amount of simulation time to wait before the task is run

Throws:

InterruptedException - execution was interrupted

IllegalStateException

cancelDefaultTask

protected void cancelDefaultTask()

Cancel the default task.

defaultCall

protected void defaultCall()

Respond to a scheduled event. Subclasses that schedule work should implement this method. When an event queued by scheduleDefaultCall is ready, this method will be called,

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 class SimObject

clone

protected Object clone()
                throws CloneNotSupportedException

Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException - a clone could not be created

See Also:

• Object.clone()

isInterned

public boolean isInterned()

Determine if an object is interned in a object namer's tables.

Specified by:

isInterned in interface NamedObjectOps

Returns:

true if the object is interned; false if not

getObjectNamer

protected Simulation getObjectNamer()

Get the object namer for a named object.

Returns:

the object namer for this named object

getName

public final String getName()

Get an object's name.

Specified by:

getName in interface NamedObjectOps

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 interface NamedObjectOps

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 interface NamedObjectOps

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 interface NamedObjectOps

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 interface NamedObjectOps

Returns:

true if deletion is pending; false otherwise