desmoj.extensions.visualization2d.animation.core.simulator

Class QueueAnimation<P extends EntityAnimation>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.QueueBased

desmoj.core.simulator.Queue<P>

desmoj.extensions.visualization2d.animation.core.simulator.QueueAnimation<P>

Type Parameters:

P -

All Implemented Interfaces:

Subject<QueueBased,QueueBased.QueueAction>, ListInterface, java.lang.Iterable<P>

public class QueueAnimation<P extends EntityAnimation>
extends Queue<P>
implements ListInterface

Animation of Queue

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
QueueAnimation(ModelAnimation owner, java.lang.String name, boolean showInReport, boolean showInTrace)
QueueAnimation(ModelAnimation owner, java.lang.String name, int sortOrder, int qCapacity, boolean showInReport, boolean showInTrace)

Method Summary

Modifier and Type	Method and Description
void	createAnimation(Comment comment, Position pos, FormExt form, boolean showInAnimation) create animation with full parameterization
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	insert(P e) insert Entity e in sortorder
boolean	insertAfter(P e, P after) insert Entity e after SimProcess after
boolean	insertBefore(P e, P before) insert SimProcess e before SimProcess before
void	remove(Entity e) Removes the given Entity from the Queue.
boolean	remove(int index) Removes the entity queued at the given position.
P	removeFirst() Removes the first entity from the queue and provides a reference to this entity.
P	removeFirst(Condition<P> c) Removes the first entity from the queue that fulfills the given condition.
P	removeLast() Removes the last entity from the queue and provides a reference to this entity.
P	removeLast(Condition<P> c) Removes the last entity from the queue that fulfills to the given condition, determined by traversing the queue from last to first until an entity fulfilling the condition is found.

Methods inherited from class desmoj.core.simulator.Queue

contains, createDefaultReporter, first, first, get, get, getQueueList, getQueueStrategy, getRefused, isEmpty, iterator, last, last, pred, pred, removeAll, reset, setQueueStrategy, setSeed, size, succ, succ

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QueueAnimation

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

QueueAnimation

public QueueAnimation(ModelAnimation owner,
                      java.lang.String name,
                      int sortOrder,
                      int qCapacity,
                      boolean showInReport,
                      boolean showInTrace)

Method Detail

createAnimation

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

create animation with full parameterization

Parameters:

pos - middle point of animation object

form - form of animation object

showInAnimation - switch animation on or off

createAnimation

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

create animation with full parameterization

Parameters:

comment -

pos - middle point of animation object

form - form of animation object

commentStyle -

commentSize -

commentColor -

commentSizeExt -

showInAnimation - switch animation on or off

getInternId

public java.lang.String getInternId()

gives the internal Id of this animation object.

Specified by:

getInternId in interface ListInterface

Returns:

insert

public boolean insert(P e)

insert Entity e in sortorder

Overrides:

insert in class Queue<P extends EntityAnimation>

Parameters:

e -

Returns:

true, when successful

insertAfter

public boolean insertAfter(P e,
                           P after)

insert Entity e after SimProcess after

Overrides:

insertAfter in class Queue<P extends EntityAnimation>

Parameters:

e -

after -

Returns:

true, when successful

insertBefore

public boolean insertBefore(P e,
                            P before)

insert SimProcess e before SimProcess before

Overrides:

insertBefore in class Queue<P extends EntityAnimation>

Parameters:

e -

before -

Returns:

true, when successful

remove

public void remove(Entity e)

Removes the given Entity from the Queue. If the given Entity is not in the Queue, a warning will be issued but nothing else will be changed.

Overrides:

remove in class Queue<P extends EntityAnimation>

Parameters:

e - Entity : The Entity to be removed

remove

public boolean remove(int index)

Removes the entity queued at the given position. The first position is 0, the last one length()-1.

Overrides:

remove in class Queue<P extends EntityAnimation>

Returns:

: The method returns true if an Entity exists at the given position or false> if otherwise.

removeFirst

public P removeFirst()

Removes the first entity from the queue and provides a reference to this entity. If the queue is empty, null is returned.

Overrides:

removeFirst in class Queue<P extends EntityAnimation>

Returns:

E : The first entity in this queue, which has been removed, or null in case the queue was empty

removeFirst

public P removeFirst(Condition<P> c)

Removes the first entity from the queue that fulfills the given condition. Also provides a reference to this entity. If the queue does not contain an entity that fulfills the condition (e.g. if the queue is empty), null is returned.

Overrides:

removeFirst in class Queue<P extends EntityAnimation>

Parameters:

c - Condition : The condition that the entity returned must fulfill

Returns:

E : The first entity in this queue fulfilling the condition, which has been removed from the queue. Null in case no entity fulfills the condition.

removeLast

public P removeLast()

Removes the last entity from the queue and provides a reference to this entity. If the queue is empty, null is returned.

Overrides:

removeLast in class Queue<P extends EntityAnimation>

Returns:

E : The last entity in this queue, which has been removed, or null in case the queue was empty

removeLast

public P removeLast(Condition<P> c)

Removes the last entity from the queue that fulfills to the given condition, determined by traversing the queue from last to first until an entity fulfilling the condition is found. Also provides a reference to this entity. If the queue does not contain an entity that fulfills the condition (e.g. if the queue is empty), null is returned.

Overrides:

removeLast in class Queue<P extends EntityAnimation>

Parameters:

c - Condition : The condition that the entity returned must fulfill

Returns:

E : The last entity in this queue fulfilling the condition, which has been removed from the queue. Null in case no entity fulfills the condition.