Module org.bzdev.drama

Package org.bzdev.drama.generic

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

All Implemented Interfaces:

NamedObjectOps

Direct Known Subclasses:

DramaSimObject, GenericDomainMember, GenericMsgFrwdngInfo, GenericTaskObject

public abstract class GenericSimObject<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 SimObject

Base class for simulation objects using generics. Because of simulation flavors, each flavor is associated with a different subclass of GenericSimulation. With the use of generics, various methods (e.g., getSimulation()) will return the specific subclass of GenericSimulation that a flavor uses. This reduces the need to use type casts.

Typically, the subclasses of GenericSimulation will provide methods to look up specific types of objects by name and provide flavor-specific operations.

The GenericSimObject class merely provides a constructor and a method for obtaining the current simulation (returning the subclass of GenericSimulation appropriate for a specific simulation flavor). Other operations are left to its subclasses.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericSimObject(S sim, String name, boolean intern)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canDelete()	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	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.
protected final S	getSimulation()	Get the simulation.
final boolean	isDeleted()	Determine if an object has been deleted.
boolean	isInterned()	Determine if an object is interned in a object namer's tables.
void	printConfiguration(String iPrefix, String prefix, boolean printName, PrintWriter out)	Print this simulation object's configuration.
void	printState(String iPrefix, String prefix, boolean printName, PrintWriter out)	Print this simulation object's state.

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

GenericSimObject

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

Constructor. When interned, these objects can be looked up by name using the methods in Simulation. For each type of simulation object that a GUI or input-file parser will support, the base class for that type must provide its class name, and should provide a constructor that requires the sim, name, and intern arguments only. Additional initialization should be done separately.

Parameters:

sim - the simulation

name - the name of the object; null for an automatically generated name

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

See Also:

• ObjectNamerOps.getObject(String,Class)

Method Details

getSimulation

protected final S getSimulation()

Get the simulation.

Returns:

the simulation associated with this object

printConfiguration

public void printConfiguration(String iPrefix,
 String prefix,
 boolean printName,
 PrintWriter out)

Print this simulation object's configuration. Documentation for the use of this method is provided by the documentation for the SimObject method SimObject.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.

Overrides:

printConfiguration in class SimObject

Parameters:

iPrefix - the prefix to use for an initial line when printName is true with null treated as an empty string

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 true

printName - requests printing the name of an object

out - the output print writer

printState

public void printState(String iPrefix,
 String prefix,
 boolean printName,
 PrintWriter out)

Print this simulation object's state. Documentation for the use of this method is provided by the documentation for the SimObject method SimObject.printState(String,String,boolean,PrintWriter). When the third 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.

Overrides:

printState in class SimObject

Parameters:

iPrefix - the prefix to use for an initial line when printName is true with null treated as an empty string

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 true

printName - requests printing the name of an object

out - the output print writer

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