Package jsl.modeling.elements.station

Class TwoWayByChanceQObjectSender

java.lang.Object

jsl.simulation.ModelElement

jsl.modeling.elements.station.TwoWayByChanceQObjectSender

All Implemented Interfaces:

RandomElementIfc, SendQObjectIfc, ObservableIfc, StreamOptionIfc, GetNameIfc, IdentityIfc, GetRandomNumberStreamIfc, RNStreamControlIfc, SetRandomNumberStreamIfc

public class TwoWayByChanceQObjectSender
extends ModelElement
implements SendQObjectIfc, RandomElementIfc

This model element randomly selects between two receivers (objects that implement ReceiveQObjectIfc) and sends the QObject to the chosen receiver. The first receiver is chosen with probability p and the second receiver is chosen with probability 1-p

Nested Class Summary

Nested classes/interfaces inherited from class jsl.simulation.ModelElement

ModelElement.EventBuilderIfc<T>, ModelElement.EventScheduler<T>, ModelElement.ModelElementComparator, ModelElement.RequestBuilder, ModelElement.RequestDurationIfc, ModelElement.RequestTimeIfc, ModelElement.RequestUsingIfc, ModelElement.TimedUpdateEventAction, ModelElement.TimeUnitIfc<T>, ModelElement.WarmUpEventAction

Field Summary

Fields inherited from class jsl.simulation.ModelElement

AFTER_EXPERIMENT, AFTER_REPLICATION, BEFORE_EXPERIMENT, BEFORE_REPLICATION, CONDITIONAL_ACTION_REGISTRATION, DEFAULT_TIMED_EVENT_PRIORITY, INITIALIZED, MONTE_CARLO, myAfterExperimentOption, myAfterReplicationOption, myBeforeExperimentOption, myBeforeReplicationOption, myInitializationOption, myLengthOfWarmUp, myModelElements, myMonteCarloOption, myObservableComponent, myReplicationEndedOption, myTimedUpdateActionListener, myTimedUpdateEvent, myTimedUpdateInterval, myTimedUpdateOption, myTimedUpdatePriority, myWarmUpActionListener, myWarmUpEvent, myWarmUpIndicator, myWarmUpOption, myWarmUpPriority, NONE, REMOVED_FROM_MODEL, REPLICATION_ENDED, TIME_UNIT_DAY, TIME_UNIT_HOUR, TIME_UNIT_MILLISECOND, TIME_UNIT_MINUTE, TIME_UNIT_SECOND, TIME_UNIT_WEEK, TIMED_UPDATE, UPDATE, WARMUP

Constructor Summary

Constructors

Constructor	Description
TwoWayByChanceQObjectSender(ModelElement parent, double p, ReceiveQObjectIfc r1, ReceiveQObjectIfc r2)
TwoWayByChanceQObjectSender(ModelElement parent, java.lang.String name, double p, ReceiveQObjectIfc r1, ReceiveQObjectIfc r2)

Method Summary

Modifier and Type	Method	Description
void	advanceToNextSubstream()	Positions the RNG at the beginning of its next substream
boolean	getAntitheticOption()
RNStreamIfc	getRandomNumberStream()
boolean	getResetNextSubStreamOption()	Gets the current reset next sub-stream option true means, that it is set to jump to the next sub-stream after each replication
boolean	getResetStartStreamOption()	Gets the current Reset Start Stream Option
int	getStreamNumber()
void	resetStartStream()	The resetStartStream method will position the RNG at the beginning of its stream.
void	resetStartSubstream()	Resets the position of the RNG at the start of the current substream
void	send(QObject qObj)
void	setAntitheticOption(boolean flag)	Tells the stream to start producing antithetic variates
void	setFirstReceiver(ReceiveQObjectIfc r1)
void	setRandomNumberStream(int streamNumber)	Assigns the stream associated with the supplied number from the default RNStreamProvider
void	setRandomNumberStream(RNStreamIfc stream)	Sets the underlying random number stream
void	setResetNextSubStreamOption(boolean b)	Sets the current reset next sub-stream option true means, that it is set to jump to the next sub-stream after each replication
void	setResetStartStreamOption(boolean b)	Sets the reset start stream option, true means that it will be reset to the starting stream
void	setSecondReceiver(ReceiveQObjectIfc r2)

Methods inherited from class jsl.simulation.ModelElement

addObserver, addObserverToModelElements, afterExperiment, afterExperiment_, afterReplication, afterReplication_, asString, beforeExperiment, beforeExperiment_, beforeReplication, beforeReplication_, buildEventGenerator, cancelTimedUpdateEvent, cancelWarmUpEvent, changeParentModelElement, checkForAfterExperiment, checkForAfterReplication, checkForBeforeExperiment, checkForBeforeReplication, checkForConditionalActionRegistration, checkForInitialize, checkForMonteCarlo, checkForRemoveFromModel, checkForReplicationEnded, checkForTimedUpdate, checkForUpdate, checkForWarmUp, checkObserverState, checkWarmUpOption, clearModelElementObservers, contains, countObservers, createEntity, createEntity, createQObject, day, deleteObserver, deleteObserverFromModelElements, deleteObservers, findModelElementWithWarmUpEvent, getAfterExperimentOption, getAfterReplicationOption, getAllCounters, getAllModelElements, getAllRandomElements, getAllResponseVariables, getAllVariables, getBeforeExperimentOption, getBeforeReplicationOption, getChildModelElementIterator, getCurrentReplicationNumber, getDefaultEntityType, getExecutive, getExperiment, getId, getInitializationOption, getInitializationOrderAsString, getLeftPreOrderTraversalCount, getLengthOfWarmUp, getModel, getModelElementCompartor, getModelElementsAsString, getModelElementsAsString, getModelElementsAsString, getMonteCarloOption, getName, getNumberOfModelElements, getObserverState, getParentModelElement, getPreviousObserverState, getReplicationEndedOption, getRightPreOrderTraversalCount, getSimulation, getSpatialModel, getStringLabel, getThisElementsCounters, getThisElementsModelElements, getThisElementsRandomVariables, getThisElementsResponseVariables, getThisElementsVariables, getTime, getTimedUpdateInterval, getTimedUpdateOption, getUpdateNotificationFlag, getVariable, getWarmUpEventTime, getWarmUpOption, hour, indent, initialize, initialize_, isTimedUpdateEventScheduled, isWarmedUp, isWarmUpEventScheduled, isWarmUpScheduled, millisecond, minute, montecarlo, montecarlo_, notifyAfterExperimentObservers, notifyAfterReplicationObservers, notifyBeforeExperimentObservers, notifyBeforeReplicationObservers, notifyConditionalActionRegistrationObservers, notifyInitializationObservers, notifyMonteCarloObservers, notifyObservers, notifyObservers, notifyRemovingFromModelObservers, notifyReplicationEndedObservers, notifyTimedUpdateObservers, notifyUpdateObservers, notifyWarmUpObservers, registerConditionalActions, registerConditionalActions_, removedFromModel, removeFromModel, replicationEnded, replicationEnded_, schedule, second, seize, setAfterExperimentOption, setAfterExperimentOptionForModelElements, setAfterReplicationOption, setAfterReplicationOptionForModelElements, setBeforeExperimentOption, setBeforeExperimentOptionForModelElements, setBeforeReplicationOption, setBeforeReplicationOptionForModelElements, setInitializationOption, setInitializationOptionForModelElements, setLengthOfWarmUp, setModel, setMonteCarloOption, setMonteCarloOptionForModelElements, setName, setObserverState, setParentModelElement, setReplicationEndedOption, setReplicationEndedOptionForModelElements, setSpatialModel, setStringLabel, setTimedUpdateInterval, setTimedUpdateOption, setTimedUpdateOptionForModelElements, setUpdateNotificationFlag, setWarmUpOption, setWarmUpOptionForModelElements, stopExecutive, stopExecutive, timedUpdate, timedUpdate_, toString, update, useControls, warmUp, warmUp_, week

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TwoWayByChanceQObjectSender

public TwoWayByChanceQObjectSender(ModelElement parent,
                                   double p,
                                   ReceiveQObjectIfc r1,
                                   ReceiveQObjectIfc r2)

TwoWayByChanceQObjectSender

public TwoWayByChanceQObjectSender(ModelElement parent,
                                   java.lang.String name,
                                   double p,
                                   ReceiveQObjectIfc r1,
                                   ReceiveQObjectIfc r2)

Method Detail

setFirstReceiver

public final void setFirstReceiver(ReceiveQObjectIfc r1)

setSecondReceiver

public final void setSecondReceiver(ReceiveQObjectIfc r2)

send

public void send(QObject qObj)

Specified by:

send in interface SendQObjectIfc

resetStartStream

public void resetStartStream()

Description copied from interface: RNStreamControlIfc

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

Specified by:

resetStartStream in interface RNStreamControlIfc

resetStartSubstream

public void resetStartSubstream()

Description copied from interface: RNStreamControlIfc

Resets the position of the RNG at the start of the current substream

Specified by:

resetStartSubstream in interface RNStreamControlIfc

advanceToNextSubstream

public void advanceToNextSubstream()

Description copied from interface: RNStreamControlIfc

Positions the RNG at the beginning of its next substream

Specified by:

advanceToNextSubstream in interface RNStreamControlIfc

setAntitheticOption

public void setAntitheticOption(boolean flag)

Description copied from interface: RNStreamControlIfc

Tells the stream to start producing antithetic variates

Specified by:

setAntitheticOption in interface RNStreamControlIfc

Parameters:

flag - true means that it produces antithetic variates.

getAntitheticOption

public boolean getAntitheticOption()

Specified by:

getAntitheticOption in interface RNStreamControlIfc

Returns:

true means on

setRandomNumberStream

public void setRandomNumberStream(RNStreamIfc stream)

Description copied from interface: SetRandomNumberStreamIfc

Sets the underlying random number stream

Specified by:

setRandomNumberStream in interface SetRandomNumberStreamIfc

Parameters:

stream - the reference to the random number stream, must not be null

setRandomNumberStream

public void setRandomNumberStream(int streamNumber)

Description copied from interface: SetRandomNumberStreamIfc

Assigns the stream associated with the supplied number from the default RNStreamProvider

Specified by:

setRandomNumberStream in interface SetRandomNumberStreamIfc

Parameters:

streamNumber - a stream number, 1, 2, etc.

getRandomNumberStream

public RNStreamIfc getRandomNumberStream()

Specified by:

getRandomNumberStream in interface GetRandomNumberStreamIfc

Returns:

the random number stream reference

getStreamNumber

public int getStreamNumber()

Specified by:

getStreamNumber in interface GetRandomNumberStreamIfc

Returns:

the stream number allocated to the random variable by the default stream provider. This will return -1 if the random variable's underlying stream was not provided by the default stream provider

getResetNextSubStreamOption

public boolean getResetNextSubStreamOption()

Description copied from interface: StreamOptionIfc

Gets the current reset next sub-stream option true means, that it is set to jump to the next sub-stream after each replication

Specified by:

getResetNextSubStreamOption in interface StreamOptionIfc

Returns:

the option

getResetStartStreamOption

public boolean getResetStartStreamOption()

Description copied from interface: StreamOptionIfc

Gets the current Reset Start Stream Option

Specified by:

getResetStartStreamOption in interface StreamOptionIfc

Returns:

the option

setResetNextSubStreamOption

public void setResetNextSubStreamOption(boolean b)

Description copied from interface: StreamOptionIfc

Sets the current reset next sub-stream option true means, that it is set to jump to the next sub-stream after each replication

Specified by:

setResetNextSubStreamOption in interface StreamOptionIfc

Parameters:

b - true means reset

setResetStartStreamOption

public void setResetStartStreamOption(boolean b)

Description copied from interface: StreamOptionIfc

Sets the reset start stream option, true means that it will be reset to the starting stream

Specified by:

setResetStartStreamOption in interface StreamOptionIfc

Parameters:

b - true means reset