desmoj.core.simulator

Class SimProcess

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.Entity

desmoj.core.simulator.SimProcess

Direct Known Subclasses:

ArrivalProcess, C_Control, ComplexSimProcess, Crane, CustomerProcess, DemandProcess, EntitySchedule, ExternalTransporter, MachineProcess, RestockProcessMS, RestockProcessMT, RestockProcessQS, RestockProcessQT, SimProcessAnimation, SpatialSimProcess, T_Control, Transporter, Worker

public abstract class SimProcess
extends Entity

SimProcess represents entities with an own active lifecycle. Since SimProcesses are in fact special entities with extended capabilities (esp. the method lifeCycle()), they inherit from Entity and thus can also be used in conjunction with events. So they can be handled in both ways, event- and process-oriented. Clients are supposed to implement the lifeCycle() method to specify the individual behaviour of a special SimProcess subclass. Since implementing activity- and transaction-oriented synchronization mechanisms requires significant changes in this class, methods that have been implemented by Soenke Claassen have been marked.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler, Soenke Claassen Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
SimProcess(Model owner, java.lang.String name, boolean showInTrace) Short-cut constructor of a SimProcess whose lifeCycle() is only executed once.
SimProcess(Model owner, java.lang.String name, boolean repeating, boolean showInTrace) The most general constructor of a SimProcess.

Method Summary

Modifier and Type	Method and Description
void	activate() Schedules the SimProcess to be activated at the current simulation time.
void	activate(TimeInstant when) Schedules the SimProcess to be activated at the given point in simulation time.
void	activate(TimeSpan dt) Schedules the SimProcess to be activated after a given span of simulation time.
void	activateAfter(Schedulable after) Schedules this SimProcess to be activated directly after the given Schedulable, which itself is already scheduled.
void	activateBefore(Schedulable before) Schedules this SimProcess to be activated directly before the given Schedulable, which itself is already scheduled.
void	activatePreempt() Schedules the SimProcess to be activated immediately at the given point in simulation time, implicitly stalling the current process until the activated process withdraws program control, referred to as process preemption.
void	cancelInterruptDelayed() Clears the currently scheduled delayed interrupt so that it wont be performed.
boolean	canCooperate() Returns true if this process can cooperate with another SimProcess.
void	clearInterruptCode() Resets the interrupt-status of this SimProcess to not interrupted.
void	cooperate() The current (master) process is calling this method (within WaitQueue.cooperate()) on the slave process to lead him through the joint cooperation.
Schedulable	getActivatedBy() Returns the last Schedulable that did cause the last activation (or interruption) of this SimProcess.
InterruptCode	getInterruptCode() Returns the InterruptCode from this SimProcess.
InterruptException	getInterruptException()
SimProcess	getMaster() Returns the master when two SimProcesses are cooperating.
long	getRealTimeConstraint() Returns the realTime deadline for this SimProcess (in nanoseconds).
int	getSchedulingPriority() Returns the process' scheduling priority.
ProcessQueue<? extends SimProcess>	getSlaveWaitQueue() Returns the waiting-queue in which this SimProcess is waiting as a slave to cooperate with a master.
ComplexSimProcess	getSupervisor() Returns the supervising ComplexSimProcess this SimProcess is contained in.
void	hold(NumericalDist<?> dist) Passivates a SimProcess for span of time sampled from the distribution provided to the method.
void	hold(TimeInstant until) Passivates a SimProcess until the given point in simulation time.
void	hold(TimeSpan dt) Passivates a SimProcess for the given span of time.
void	interrupt(InterruptCode interruptReason) Interrupts the SimProcess setting the given InterruptCode as the reason for the interruption.
void	interrupt(InterruptException interruptReason) Interrupts the SimProcess by throwing the given InterruptException in it's lifeCylce() method.
ExternalEvent	interruptDelayed(TimeInstant when) Schedules this process to be interrupted at the given point in simulation time.
ExternalEvent	interruptDelayed(TimeSpan delay) Schedules this process to be interrupted after the given delay.
boolean	isBlocked() Returns the current block-status of the SimProcess.
boolean	isComponent() Returns the current component status of this SimProcess.
boolean	isDelayedInterruptScheduled()
boolean	isInterrupted() Returns the current interrupt-status of this SimProcess.
boolean	isRepeating() Returns the current repeating-status of the SimProcess.
boolean	isTerminated() Returns the current status of the SimProcess.
abstract void	lifeCycle() Override this method in a subclass of SimProcess to implement the specific behaviour of this SimProcess.
void	obtainResources(Resource[] obtainedResources) Makes the SimProcess obtain an array of resources and store them for further usage.
void	passivate() Passivates the SimProcess for an indefinite time.
void	prepareTransport() The current (master) process is calling this method (within TransportJunction.cooperate()) on the slave process to make him prepare for the transportation.
void	reActivate(TimeInstant when) Re-schedules the activation of this process (which must be exaxctly one) by setting it to the TimeInstant passed to this method.
void	reActivate(TimeSpan dt) Re-schedules all SimProcess activation by adding a TimeSpan to the current activation times.
void	resetMaster() Gets the InterruptCode from the master and resets the master to null.
void	returnAllResources() Makes the SimProcess return all resources it holds at the moment to all the different Res pools it is holding resources from.
Resource[]	returnResources(Res resPool, int n) Makes the SimProcess return a certain number of resources of the given resource pool.
void	setBlocked(boolean blockStatus) Sets the SimProcess' blocked status to the boolean value given.
void	setRealTimeConstraint(long realTimeConstraint) Sets the realTime deadline for this SimProcess (in nanoseconds).
void	setRepeating(boolean repeatingStatus) Sets the SimProcess' repeating status to the boolean value given, permitting the process' lifeCycle to either start again (true) or terminate (false) after the current cycle is completed.
void	setSchedulingPriority(int newPriority) Sets the process' scheduling priority to a given integer value.
void	setSlaveWaitQueue(ProcessQueue<? extends SimProcess> slvWaitQueue) Sets the SimProcess' slaveWaitQueue variable to the ProcessQueue in which this SimProcess is waiting as a slave to cooperate with a master.

Methods inherited from class desmoj.core.simulator.Entity

getIdentNumber, getQueueingPriority, getQueues, getScheduledEvents, isEqual, isLarger, isLargerOrEqual, isNotEqual, isQueued, isSimProcess, isSmaller, isSmallerOrEqual, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, scheduleAfter, scheduleAfter, scheduleAfter, scheduleBefore, scheduleBefore, scheduleBefore, schedulePreempt, schedulePreempt, schedulePreempt, setQueueingPriority

Methods inherited from class desmoj.core.simulator.Schedulable

assignReporter, cancel, getCorrespondingReportable, isCurrent, isScheduled, rename, reSchedule, reSchedule, reSchedulePreempt, scheduledNext, setCorrespondingReportable

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimProcess

public SimProcess(Model owner,
                  java.lang.String name,
                  boolean repeating,
                  boolean showInTrace)

The most general constructor of a SimProcess.

Parameters:

name - String : The name of the SimProcess

owner - Model : The model this SimProcess is associated to

repeating - boolean : Flag to set the SimProcess' repeating behaviour: If set to true, the lifeCycle will be executed again after completion, while false will create a process whose lifeCycle is executed only once.

showInTrace - boolean : Flag for showing SimProcess in trace-files. Set it to true if SimProcess should show up in trace. Set it to false if SimProcess should not be shown in trace.

SimProcess

public SimProcess(Model owner,
                  java.lang.String name,
                  boolean showInTrace)

Short-cut constructor of a SimProcess whose lifeCycle() is only executed once.

Parameters:

name - String : The name of the SimProcess

owner - Model : The model this SimProcess is associated to

showInTrace - boolean : Flag for showing SimProcess in trace-files. Set it to true if SimProcess should show up in trace. Set it to false if SimProcess should not be shown in trace.

Method Detail

activate

public void activate()

Schedules the SimProcess to be activated at the current simulation time. This will allow a passivated SimProcess to resume executing its lifeCycle method.
Process preemption is not permitted: The activated process is resumed after the current process (or other Schedulable) has transferred program control back to the Scheduler, e.g. by calling hold(...) or passivate(). If process preemption is desired, please use method activatePreempt().

activatePreempt

public void activatePreempt()
                     throws SuspendExecution

Schedules the SimProcess to be activated immediately at the given point in simulation time, implicitly stalling the current process until the activated process withdraws program control, referred to as process preemption.

Throws:

SuspendExecution

activate

public void activate(TimeInstant when)

Schedules the SimProcess to be activated at the given point in simulation time. This will allow a passivated SimProcess to resume executing its lifeCycle method.
Process preemption is not permitted: Even if the argument passed is equal to presentTime(), the activated process is resumed after the current process (or other Schedulable) has transferred program control back to the Scheduler, e.g. by calling hold(...) or passivate(). If process preemption is desired, please use method activatePreempt().

Parameters:

when - TimeInstant : The point in simulation time this process is to be activated.

activate

public void activate(TimeSpan dt)

Schedules the SimProcess to be activated after a given span of simulation time. This will allow a passivated SimProcess to resume executing its lifeCycle method.
Process preemption is not permitted: Even if the argument passed is equal to TimeSpan(0), the activated process is resumed after the current process (or other Schedulable) has transferred program control back to the Scheduler, e.g. by calling hold(...) or passivate(). If process preemption is desired, please use method activatePreempt().
Note that for the frequent pattern activate(new TimeSpan(0)), the shorm form activate() exists.

Parameters:

dt - TimeSpan : The offset to the current simulation time this process is to be activated

activateAfter

public void activateAfter(Schedulable after)

Schedules this SimProcess to be activated directly after the given Schedulable, which itself is already scheduled. Note that this SimProcess' point of simulation time will be set to be the same as the Schedulable's time. Thus this SimProcess will continue to execute its lifeCycle() method directly after the given Schedulable but the simulation clock will not change. Please make sure that the Schedulable given as parameter is actually scheduled.

Parameters:

after - Schedulable : The Schedulable this SimProcess should be scheduled after

activateBefore

public void activateBefore(Schedulable before)

Schedules this SimProcess to be activated directly before the given Schedulable, which itself is already scheduled. Note that this SimProcess' point of simulation time will be set to be the same as the Schedulable's time. Thus this SimProcess will continue to execute its lifeCycle() method directly before the given Schedulable but the simulation clock will not change. Please make sure that the Schedulable given as parameter is actually scheduled.

Parameters:

before - Schedulable : The Schedulable this SimProcess should be scheduled before

cancelInterruptDelayed

public void cancelInterruptDelayed()

Clears the currently scheduled delayed interrupt so that it wont be performed. This Method should be called to cancel a previously scheduled delayed interrupt. This is typically the case if all steps to be covered by the delayed interrupt have been performed in time (before the delayed interrupt could be executed).

isDelayedInterruptScheduled

public boolean isDelayedInterruptScheduled()

canCooperate

public boolean canCooperate()

Returns true if this process can cooperate with another SimProcess. If this process is already cooperating with a master false is returned.

Returns:

boolean : Is this process ready to cooperate with another SimProcess?

clearInterruptCode

public void clearInterruptCode()

Resets the interrupt-status of this SimProcess to not interrupted. Should be called every time the SimProcess has successfully dealt with the interrupt. The internal InterruptCode of this SimProcess will be reset to null.

cooperate

public void cooperate()

The current (master) process is calling this method (within WaitQueue.cooperate()) on the slave process to lead him through the joint cooperation. After the joint cooperation is finished the master is still active and after him the slave will be activated.

getInterruptCode

public InterruptCode getInterruptCode()

Returns the InterruptCode from this SimProcess. If this SimProcess is not interrupted, the InterruptCode is null.

Returns:

irqCode : The InterruptCode of this SimProcess.

getInterruptException

public InterruptException getInterruptException()

getMaster

public SimProcess getMaster()

Returns the master when two SimProcesses are cooperating. If this method is called on a SimProcess which is not a slave null is returned.

Returns:

SimProcess : The master process during the cooperation or null if this process is not a slave process.

getRealTimeConstraint

public long getRealTimeConstraint()

Returns the realTime deadline for this SimProcess (in nanoseconds). In case of a real-time execution (i. e. the execution speed rate is set to a positive value) the Scheduler will produce a warning message if a deadline is missed.

Returns:

the realTimeConstraint in nanoseconds

getSlaveWaitQueue

public ProcessQueue<? extends SimProcess> getSlaveWaitQueue()

Returns the waiting-queue in which this SimProcess is waiting as a slave to cooperate with a master. If this method is called on a SimProcess which is not a slave null is returned.

Returns:

ProcessQueue : The waiting-queue in which this SimProcess is waiting as a slave or null if this SimProcess is not waiting as a slave for cooperation.

getSupervisor

public ComplexSimProcess getSupervisor()

Returns the supervising ComplexSimProcess this SimProcess is contained in.

Returns:

ComplexSimProcess : The supervising ComplexSimProcess this SimProcess is contained in. Is null if this SimProcess is not contained in any ComplexSimProcess.

getActivatedBy

public Schedulable getActivatedBy()

Returns the last Schedulable that did cause the last activation (or interruption) of this SimProcess.

Returns:

Schedulable : The Schedulable (e.g. other SimProcess, Event...) that has caused the last activation of this SimProcess. As processes may activate themselves, e.g. though a hold(TimeSpan t) or an activate(TimeSpan t), this method may return a reference to this process. The method returns null if this process has not yet been activated.

hold

public void hold(TimeInstant until)
          throws DelayedInterruptException,
                 InterruptException,
                 SuspendExecution

Passivates a SimProcess until the given point in simulation time. The simthread of this SimProcess is put into a lock and the scheduler, resp. the experiment's main thread is released from its block and continues with the next event-note to be processed.

Parameters:

until - TimeInstant : The point in simulation time when the SimProcess' passivation ends.

Throws:

DelayedInterruptException

InterruptException

SuspendExecution

hold

public void hold(TimeSpan dt)
          throws DelayedInterruptException,
                 InterruptException,
                 SuspendExecution

Passivates a SimProcess for the given span of time. The simthread of this SimProcess is put into a lock and the scheduler, resp. the experiment's main thread is released from its block and continues with the next EventNote to be processed.

Parameters:

dt - TimeSpan : The duration of the SimProcess' passivation

Throws:

DelayedInterruptException

InterruptException

SuspendExecution

hold

public void hold(NumericalDist<?> dist)
          throws DelayedInterruptException,
                 InterruptException,
                 SuspendExecution

Passivates a SimProcess for span of time sampled from the distribution provided to the method. The sample is interpreted in the reference time unit. The SimThread of this SimProcess is put into a lock and the scheduler, resp. the experiment's main thread is released from its block and continues with the next EventNote to be processed.

Parameters:

dist - NumericalDist : Numerical distribution to sample the duration of the SimProcess' passivation from

Throws:

DelayedInterruptException

InterruptException

SuspendExecution

interrupt

public void interrupt(InterruptCode interruptReason)

Interrupts the SimProcess setting the given InterruptCode as the reason for the interruption. Blocked, terminated or already interrupted SimProcesses can not be interrupted. In this case a warning message will be produced and the interrupt will be ignord. If the SimProcess is cooperating as a slave the interrupt will be passed to the master.

Parameters:

interruptReason - desmoj.InterruptCode

interrupt

public void interrupt(InterruptException interruptReason)

Interrupts the SimProcess by throwing the given InterruptException in it's lifeCylce() method. The InterruptException contains an InterruptCode as the reason for the interruption. Blocked, terminated or already interrupted SimProcesses can not be interrupted. In this case a warning message will be produced and the interrupt will be ignord. If the SimProcess is cooperating as a slave the interrupt will be passed to the master.

Parameters:

interruptReason - desmoj.InterruptException

interruptDelayed

public ExternalEvent interruptDelayed(TimeInstant when)

Schedules this process to be interrupted at the given point in simulation time. Only one delayed interrupt can be scheduled at a time. If a delayed interrupt is scheduled after another delayed interrupt has already been scheduled a warning message will be produced and the new delayed interrupt will not be scheduled. A delayed Interrupt must be cleared manually by calling clearInterruptDelayed() on the SimProcess if it wasn't performed.

Parameters:

when - The Point in time when the interrupt is to be performed.

Returns:

The event which will (at the given point in time) triger the interrupt of this process

interruptDelayed

public ExternalEvent interruptDelayed(TimeSpan delay)

Schedules this process to be interrupted after the given delay. Only one delayed interrupt can be scheduled at a time. If a delayed interrupt is scheduled after another delayed interrupt has already been scheduled a warning message will be produced and the delayed interrupt will not be scheduled. A delayed Interrupt must be cleared manually by calling clearInterruptDelayed() on the SimProcess if it wasn't performed.

Parameters:

delay - The delay after which the interrupt is to be performed.

Returns:

The event which will (after the given delay) triger the interrupt of this process

isBlocked

public boolean isBlocked()

Returns the current block-status of the SimProcess. If a SimProcess is blocked, it is waiting inside a queue or synchronization block for it's release.

Returns:

boolean : Is true if SimProcess is blocked, false otherwise

isRepeating

public boolean isRepeating()

Returns the current repeating-status of the SimProcess. If a SimProcess is repeating, the lifeCycle will be executed again after finishing.

Returns:

boolean : Is true if the lifeCycle of the process will be repeated finishing, while false indicates the process will terminate after the lifeCycle is completed.

isComponent

public boolean isComponent()

Returns the current component status of this SimProcess. If a SimProcess is a component of a ComplexSimProcess it is blocked and passivated. It exists only within the ComplexSimProcess; it's own lifeCycle is stopped and will only be activated again when it is removed from the ComplexSimProcess.

Returns:

boolean :true if and only if this SimProcess is a component (part of) a ComplexSimProcess; false otherwise.

isInterrupted

public boolean isInterrupted()

Returns the current interrupt-status of this SimProcess. If a SimProcess is interrupted, it should deal with the interrupt and then call the clearInterruptCode() -method.

Returns:

boolean : Is true if this SimProcess is interrupted, false otherwise.

isTerminated

public boolean isTerminated()

Returns the current status of the SimProcess. If a SimProcess is terminated, it has already finished its lifeCycle() method and can not further be used as a SimProcess. A terminated SimProcess can still be used like any other Entity which it is derived from.

Returns:

boolean : Is true if the SimProcess is terminated, false otherwise

See Also:

Entity

lifeCycle

public abstract void lifeCycle()
                        throws SuspendExecution

Override this method in a subclass of SimProcess to implement the specific behaviour of this SimProcess. This method starts after a SimProcess has been created and activated. Note that this method will be executed once or repeatedly, depending on the repeating status of the SimProcess.

Throws:

SuspendExecution

obtainResources

public void obtainResources(Resource[] obtainedResources)

Makes the SimProcess obtain an array of resources and store them for further usage.

Parameters:

obtainedResources - Resource[] : The array of resources obtained.

passivate

public void passivate()
               throws DelayedInterruptException,
                      InterruptException,
                      SuspendExecution

Passivates the SimProcess for an indefinite time. This method must be called by the SimProcess' own Thread only. The SimProcess can only be reactivated by another SimProcess or Entity.

Throws:

DelayedInterruptException

InterruptException

SuspendExecution

prepareTransport

public void prepareTransport()

The current (master) process is calling this method (within TransportJunction.cooperate()) on the slave process to make him prepare for the transportation. After the transport is finished the master is still active and after him the slave will be activated.

reActivate

public void reActivate(TimeSpan dt)

Re-schedules all SimProcess activation by adding a TimeSpan to the current activation times.

Parameters:

dt - TimeSpan : The offset to the current activation times to be added to all activation times.

reActivate

public void reActivate(TimeInstant when)

Re-schedules the activation of this process (which must be exaxctly one) by setting it to the TimeInstant passed to this method. No preemption.

Parameters:

when - TimeInstant : The point in simulation time this process is to be reactivated.

resetMaster

public void resetMaster()

Gets the InterruptCode from the master and resets the master to null.

returnAllResources

public void returnAllResources()

Makes the SimProcess return all resources it holds at the moment to all the different Res pools it is holding resources from. This is useful in situations the Simprocess is about to terminate.

returnResources

public Resource[] returnResources(Res resPool,
                                  int n)

Makes the SimProcess return a certain number of resources of the given resource pool.

Parameters:

resPool - Res : The resource pool which resources will be returned.

n - int : The number of resources which will be returned.

Returns:

Resource[] : the array containing the resources which will be returned.

setBlocked

public void setBlocked(boolean blockStatus)

Sets the SimProcess' blocked status to the boolean value given. This is necessary for some operations in conjunction with some synchronization classes.

Parameters:

blockStatus - boolean : The new value for the blocked status

setRepeating

public void setRepeating(boolean repeatingStatus)

Sets the SimProcess' repeating status to the boolean value given, permitting the process' lifeCycle to either start again (true) or terminate (false) after the current cycle is completed. Note that setting setting this property to true after the the process has terinated has no effect.

Parameters:

repeatingStatus - boolean : The new value for the repeating status

setRealTimeConstraint

public void setRealTimeConstraint(long realTimeConstraint)

Sets the realTime deadline for this SimProcess (in nanoseconds). In case of a real-time execution (i. e. the execution speed rate is set to a positive value) the Scheduler will produce a warning message if a deadline is missed.

Parameters:

realTimeConstraint - the realTimeConstraint in nanoseconds to set

setSlaveWaitQueue

public void setSlaveWaitQueue(ProcessQueue<? extends SimProcess> slvWaitQueue)

Sets the SimProcess' slaveWaitQueue variable to the ProcessQueue in which this SimProcess is waiting as a slave to cooperate with a master.

Parameters:

slvWaitQueue - ProcessQueue : The waiting-queue in which this SimProcess is waiting as a slave to cooperate with a master.

getSchedulingPriority

public int getSchedulingPriority()

Returns the process' scheduling priority. The scheduling priority is used to determine which process to execute first if two or more processes are activated at the same instant. The default priority is zero. Higher priorities are positive, lower priorities negative.

Returns:

int : The process' priority

setSchedulingPriority

public void setSchedulingPriority(int newPriority)

Sets the process' scheduling priority to a given integer value. The default priority (unless assigned otherwise) is zero. Negative priorities are lower, positive priorities are higher. All values should be inside the range defined by Java's integral integer data type [-2147483648, +2147483647]. An process' scheduling priority it used to determine which process is executed first if activated at the same time instant. Should the priority be the same, order of event execution depends on the EventList in use, e.g. activated first is executed first (EventTreeList) or random (RandomizingEventTreeList).

Parameters:

newPriority - int : The new scheduling priority value