Module org.bzdev.devqsim

Package org.bzdev.devqsim.rv

Class SimRandomVariable<T,RV extends RandomVariable<T>>

java.lang.Object

org.bzdev.devqsim.SimObject

org.bzdev.devqsim.DefaultSimObject

org.bzdev.devqsim.rv.SimRandomVariable<T,RV>

All Implemented Interfaces:

RandomVariableOps<T>, NamedObjectOps, NamedRandomVariableOps<T,RV>

Direct Known Subclasses:

SimBooleanRV, SimDoubleRV, SimIntegerRV, SimLongRV, SimRandomVariableRV

public abstract class SimRandomVariable<T,RV extends RandomVariable<T>>
extends DefaultSimObject
implements NamedRandomVariableOps<T,RV>

Base class for named objects representing random variables. The type parameters are

• T - the type of the values generated by the random variable
• RV - the type of the random variable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimRandomVariable(Simulation sim, String name, boolean intern)	Constructor.
protected	SimRandomVariable(Simulation sim, String name, boolean intern, RV rv)	Constructor given a random variable.

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.
RV	getRandomVariable()	Get the random variable that this named object represents.
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	setRV(RandomVariable<?> rv)	Set the random variable.
Spliterator<T>	spliterator()	Get a spliterator for an infinite number of values.
Spliterator<T>	spliterator(long size)	Get a spliterator for a specified number of values.

Methods inherited from class org.bzdev.devqsim.DefaultSimObject

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

Methods inherited from interface org.bzdev.obnaming.NamedRandomVariableOps

getMaximum, getMaximumClosed, getMinimum, getMinimumClosed, next, setMaximum, setMinimum, tightenMaximum, tightenMaximumS, tightenMinimum, tightenMinimumS

Constructor Details

SimRandomVariable

protected SimRandomVariable(Simulation sim,
 String name,
 boolean intern)

Constructor.

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)

SimRandomVariable

protected SimRandomVariable(Simulation sim,
 String name,
 boolean intern,
 RV rv)

Constructor given a random variable.

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

rv - the random variable itself in Simulation; false otherwise.

Throws:

IllegalArgumentException - typically means a name is already in use

See Also:

• ObjectNamerOps.getObject(String,Class)

Method Details

getRandomVariable

public RV getRandomVariable()

Get the random variable that this named object represents.

Specified by:

getRandomVariable in interface NamedRandomVariableOps<T,RV extends RandomVariable<T>>

Returns:

the random variable

setRV

protected void setRV(RandomVariable<?> rv)

Set the random variable. Typically this will be called in a constructor, not elsewhere.

Parameters:

rv - the random variable itself

spliterator

public Spliterator<T> spliterator(long size)

Get a spliterator for a specified number of values.

Parameters:

size - the number of random values to provide

Returns:

the spliterator

spliterator

public Spliterator<T> spliterator()

Get a spliterator for an infinite number of values.

Returns:

the spliterator

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