desmoj.core.simulator

Class ComplexSimProcess

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.Entity

desmoj.core.simulator.SimProcess

desmoj.core.simulator.ComplexSimProcess

public abstract class ComplexSimProcess
extends SimProcess

A ComplexSimProcess is a SimProcess which serves as a container for other SimProcess es. A ComplexSimProcess has its own lifecycle. As long as this ComplexSimProcess is active all its contained Simprocesses are passive. That means they are blocked and can not proceed in their lifeCycles.

Version:

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

Author:

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
ComplexSimProcess(Model owner, java.lang.String name, boolean showInTrace) Constructs a ComplexSimProcess.

Method Summary

Modifier and Type	Method and Description
void	addComponent(SimProcess compnt) Adds a SimProcess as a component to this ComplexSimProcess.
boolean	contains(SimProcess elem) Checks if the given SimProcess is contained in this ComplexSimProcess already.
java.util.Enumeration<SimProcess>	getComponents() Returns all the components of this ComplexSimProcess as an java.util.Enumeration.
boolean	hasComponents() Checks if this ComplexSimProcess has components or not.
abstract void	lifeCycle() Override this method in a subclass of ComplexSimProcess to implement the specific behaviour of this process.
void	removeAllComponents() Removes all elements (SimProcesses and ComplexSimProcesses) from this ComplexSimProcess.
void	removeComponent(SimProcess elem) Removes a SimProcess from the elements of this ComplexSimProcess.
java.lang.String	toString() Returns a String representation of this ComplexSimProcess, containing the String representation of each SimProcess component.

Methods inherited from class desmoj.core.simulator.SimProcess

activate, activate, activate, activateAfter, activateBefore, activatePreempt, cancelInterruptDelayed, canCooperate, clearInterruptCode, cooperate, getActivatedBy, getInterruptCode, getInterruptException, getMaster, getRealTimeConstraint, getSchedulingPriority, getSlaveWaitQueue, getSupervisor, hold, hold, hold, interrupt, interrupt, interruptDelayed, interruptDelayed, isBlocked, isComponent, isDelayedInterruptScheduled, isInterrupted, isRepeating, isTerminated, obtainResources, passivate, prepareTransport, reActivate, reActivate, resetMaster, returnAllResources, returnResources, setBlocked, setRealTimeConstraint, setRepeating, setSchedulingPriority, setSlaveWaitQueue

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexSimProcess

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

Constructs a ComplexSimProcess.

Parameters:

owner - desmoj.Model : The model this ComplexSimProcess is associated to.

name - java.lang.String : The name of this ComplexSimProcess.

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

Method Detail

addComponent

public void addComponent(SimProcess compnt)
                  throws SuspendExecution

Adds a SimProcess as a component to this ComplexSimProcess. The Sim-process being added to the ComplexSimProcess will be passivated and blocked. Use method removeComponent() to remove the Sim-process from the ComplexSimProcess again.

Parameters:

compnt - desmoj.SimProcess : The SimProcess to be added as a component to this ComplexSimProcess.

Throws:

SuspendExecution

contains

public boolean contains(SimProcess elem)

Checks if the given SimProcess is contained in this ComplexSimProcess already.

Parameters:

elem - desmoj.SimProcess : The SimProcess which might be an element of this ComplexSimPorcess already.

Returns:

boolean :true if and only if the specified SimProcess is the same as a component in this ComplexSimProcess, as determined by the equals() method; false otherwise.

See Also:

Vector

getComponents

public java.util.Enumeration<SimProcess> getComponents()

Returns all the components of this ComplexSimProcess as an java.util.Enumeration.

Returns:

java.util.Enumeration : All the components of this ComplexSimProcess.

See Also:

Enumeration

hasComponents

public boolean hasComponents()

Checks if this ComplexSimProcess has components or not.

Returns:

boolean :true if and only if this ComplexSimProcess has components; false otherwise.

lifeCycle

public abstract void lifeCycle()
                        throws co.paralleluniverse.fibers.SuspendExecution

Override this method in a subclass of ComplexSimProcess to implement the specific behaviour of this process. This method starts after a ComplexSimProcess has been created and activated by the scheduler. As long as this ComplexSimProcess is active all its contained Simprocesses are passive. That means they are blocked and can not proceed in their lifeCycles.

Specified by:

lifeCycle in class SimProcess

Throws:

co.paralleluniverse.fibers.SuspendExecution

removeAllComponents

public void removeAllComponents()

Removes all elements (SimProcesses and ComplexSimProcesses) from this ComplexSimProcess. This will be done for all ComplexSimPorcesses recursively, until all simple SimProcesses are removed. The SimProcesses being removed from the ComplexSimProcess will be activated after the current SimProcess so they can follow their own lifeCycle again. Of course, this does only make sense for SimProcesses which are not terminated already.

removeComponent

public void removeComponent(SimProcess elem)

Removes a SimProcess from the elements of this ComplexSimProcess. The Sim-process being removed from the ComplexSimProcess will be activated after the current SimProcess so it can follow its own lifeCycle again.

Parameters:

elem - desmoj.SimProcess : The SimProcess to be removed from the elements of this ComplexSimProcess. Be careful, it might also be a ComplexSimProcess.

toString

public java.lang.String toString()

Returns a String representation of this ComplexSimProcess, containing the String representation of each SimProcess component.

Overrides:

toString in class NamedObject

Returns:

java.lang.String : A String representation of this ComplexSimProcess.