desmoj.extensions.visualization2d.animation.core.advancedModellingFeatures

Class WaitQueueAnimation

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.QueueBased

desmoj.core.advancedModellingFeatures.WaitQueue

desmoj.extensions.visualization2d.animation.core.advancedModellingFeatures.WaitQueueAnimation

All Implemented Interfaces:

Subject<QueueBased,QueueBased.QueueAction>

public class WaitQueueAnimation
extends WaitQueue

Animation of a WaitQueue

Version:

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

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ 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.

Nested Class Summary

Nested classes/interfaces inherited from class desmoj.core.simulator.QueueBased

QueueBased.QueueAction

Field Summary

Fields inherited from class desmoj.core.simulator.QueueBased

FIFO, LIFO, RANDOM, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
WaitQueueAnimation(ModelAnimation owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor with same parameters as WaitQueue
WaitQueueAnimation(ModelAnimation owner, java.lang.String name, int masterSortOrder, int masterQCapacity, int slaveSortOrder, int slaveQCapacity, boolean showInReport, boolean showInTrace) Constructor with same parameters as WaitQueue

Method Summary

Modifier and Type	Method and Description
boolean	animationIsOn()
boolean	cooperate(ProcessCoopAnimation coop) This method is called from a SimProcessAnimation which wants to cooperate as master
boolean	cooperate(ProcessCoopAnimation coop, Condition cond) This method is called from a SimProcessAnimation which wants to cooperate as master and is looking for a slave complying to a certain condition described in cond
void	createAnimation(Position pos, FormExt form, boolean showInAnimation) create animation with full parameterization
java.lang.String	getInternId() gives the internal Id of this animation object.
boolean	waitOnCoop() This method is called from a SimProcessAnimation which wants to cooperate as a slave.

Methods inherited from class desmoj.core.advancedModellingFeatures.WaitQueue

avail, availMaster, cancelCoop, cooperate, cooperate, createDefaultReporter, getCooperationsCompleted, getMQueueStrategy, getMRefused, getMRemoved, getSlaveQueue, getSQueueStrategy, getSRefused, getSRemoved, mAverageCoopTime, mAverageLength, mAverageWaitTime, mIsEmpty, mLength, mMaxLength, mMaxLengthAt, mMaxWaitTime, mMaxWaitTimeAt, mMinLength, mMinLengthAt, mStdDevLength, mStdDevWaitTime, mZeroWaits, reset, sAverageLength, sAverageWaitTime, sIsEmpty, sLength, sMaxLength, sMaxLengthAt, sMaxWaitTime, sMaxWaitTimeAt, sMinLength, sMinLengthAt, sStdDevLength, sStdDevWaitTime, sZeroWaits

Methods inherited from class desmoj.core.simulator.QueueBased

addObserver, averageLength, averageWaitTime, deleteObserver, getQueueLimit, length, maxLength, maxLengthAt, maxWaitTime, maxWaitTimeAt, minLength, minLengthAt, notifyObservers, setQueueImpWarning, stdDevLength, stdDevWaitTime, zeroWaits

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

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

WaitQueueAnimation

public WaitQueueAnimation(ModelAnimation owner,
                          java.lang.String name,
                          int masterSortOrder,
                          int masterQCapacity,
                          int slaveSortOrder,
                          int slaveQCapacity,
                          boolean showInReport,
                          boolean showInTrace)

Constructor with same parameters as WaitQueue

Parameters:

owner - used model

name - as in WaitQueue

masterSortOrder - as in WaitQueue

masterQCapacity - as in WaitQueue

slaveSortOrder - as in WaitQueue

slaveQCapacity - as in WaitQueue

showInReport - as in WaitQueue

showInTrace - as in WaitQueue

WaitQueueAnimation

public WaitQueueAnimation(ModelAnimation owner,
                          java.lang.String name,
                          boolean showInReport,
                          boolean showInTrace)

Constructor with same parameters as WaitQueue

Parameters:

owner - used model

name - as in WaitQueue

showInReport - as in WaitQueue

showInTrace - as in WaitQueue

Method Detail

createAnimation

public void createAnimation(Position pos,
                            FormExt form,
                            boolean showInAnimation)

create animation with full parameterization

Parameters:

id - internal objectId for animation. Must be unique.

pos - middle point of animation object

form - form of animation object

showInAnimation - switch animation on or off

getInternId

public java.lang.String getInternId()

gives the internal Id of this animation object.

Returns:

cooperate

public boolean cooperate(ProcessCoopAnimation coop)
                  throws SuspendExecution

This method is called from a SimProcessAnimation which wants to cooperate as master

Parameters:

coop - as in waitQueue

Returns:

Throws:

SuspendExecution

cooperate

public boolean cooperate(ProcessCoopAnimation coop,
                         Condition cond)
                  throws SuspendExecution

This method is called from a SimProcessAnimation which wants to cooperate as master and is looking for a slave complying to a certain condition described in cond

Parameters:

coop - as in waitQueue

cond - as in waitQueue

Returns:

Throws:

SuspendExecution

waitOnCoop

public boolean waitOnCoop()
                   throws SuspendExecution

This method is called from a SimProcessAnimation which wants to cooperate as a slave.

Overrides:

waitOnCoop in class WaitQueue

Returns:

boolean : Is true if the process can be enqueued successfully, false otherwise (i.e. capacity limit of the slave queue is reached).

Throws:

SuspendExecution

animationIsOn

public boolean animationIsOn()