desmoj.extensions.space3D

Class SpatialQueue<E extends Entity>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.QueueBased

desmoj.core.simulator.Queue<E>

desmoj.extensions.space3D.SpatialQueue<E>

All Implemented Interfaces:

Subject<QueueBased,QueueBased.QueueAction>, SpatialObject, VisibleObject, java.lang.Iterable<E>

public class SpatialQueue<E extends Entity>
extends Queue<E>
implements SpatialObject, VisibleObject

This class extends the desmoj.core.simulator.Queue<E> with spatial functionalities. Every SpatialQueue is associated with a spatial position and orientation.

Author:

Fred Sun

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
SpatialQueue(Model owner, java.lang.String name, java.lang.String visualModel, boolean showInReport, boolean showInTrace, Length startPositionX, Length startPositionY, Length startPositionZ) Constructs a SpatialQueue at the specific position.
SpatialQueue(Model owner, java.lang.String name, java.lang.String visualModel, int sortOrder, int qCapacity, boolean showInReport, boolean showInTrace, Length startPositionX, Length startPositionY, Length startPositionZ) Constructs a SpatialQueue at the specific position.

Method Summary

Modifier and Type	Method and Description
void	addEntryPoint(java.lang.String name, Length xPos, Length yPos, Length zPos) Adds an entry point to this SpatialObject.
void	addExitPoint(java.lang.String name, Length xPos, Length yPos, Length zPos) Adds an exit point to this SpatialObject.
Length[]	getEntryPoint(java.lang.String name) Gets the position of the given entry point.
Length[]	getEntryPointGlobal(java.lang.String name) Gets the position of the entry point in global coordinates.
java.util.Set<java.lang.String>	getEntryPointNames() Gets a set of names of all the entry points this SpatialObject contains.
Length[]	getExitPoint(java.lang.String name) Gets the position of the given exit point.
Length[]	getExitPointGlobal(java.lang.String name) Gets the position of the exit point in global coordinates.
java.util.Set<java.lang.String>	getExitPointNames() Gets a set of names of all the exit points this SpatialObject contains.
Matrix4d	getMatrix() Gets a 4x4 double matrix object which contains the spatial data of the SpatialObejct.
Length	getPosX()
Length	getPosY()
Length	getPosZ()
java.lang.String	getVisualModel() Get the type of the SpatialObject.
boolean	isMovable() Check whether this Object is a MovableSpatialObject or not.
boolean	isVisible() Shows the visibility of the visual representation of this object.
void	removeVisible() Sends a RemoveEvent to signal the observers that this object isn't needed anymore.
void	resetRotation() Resets the rotation of the object.
void	rotX(double angle) Adds a rotation about the x-axis to the current orientation.
void	rotY(double angle) Adds a rotation about the y-axis to the current orientation.
void	rotZ(double angle) Adds a rotation about the z-axis to the current orientation.
void	setPosition(Length x, Length y, Length z) It sets the new position for the object
void	setVisible(boolean visible) Sets the visibility of the visual representation of this object.

Methods inherited from class desmoj.core.simulator.Queue

contains, createDefaultReporter, first, first, get, get, getQueueList, getQueueStrategy, getRefused, insert, insertAfter, insertBefore, isEmpty, iterator, last, last, pred, pred, remove, remove, removeAll, removeFirst, removeFirst, removeLast, removeLast, 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 desmoj.extensions.space3D.SpatialObject

getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpatialQueue

public SpatialQueue(Model owner,
                    java.lang.String name,
                    java.lang.String visualModel,
                    boolean showInReport,
                    boolean showInTrace,
                    Length startPositionX,
                    Length startPositionY,
                    Length startPositionZ)

Constructs a SpatialQueue at the specific position. Beside of the spatial extension the behaviors and the functionalities of the SpatialQueue remain the same as the Queue. For more information about the Queue, and the constructor, please see desmoj.core.simulator.Queue<E>

Parameters:

owner - The model this queue is associated to.

name - The queue's name.

visualModel - The visual model attribute belongs to the SpatialObject interface.

showInReport - Flag if queue should produce a report.

showInTrace - Flag for queue to produce trace messages.

startPositionX - The x-coordinate of the start position.

startPositionY - The y-coordinate of the start position.

startPositionZ - The z-coordinate of the start position.

SpatialQueue

public SpatialQueue(Model owner,
                    java.lang.String name,
                    java.lang.String visualModel,
                    int sortOrder,
                    int qCapacity,
                    boolean showInReport,
                    boolean showInTrace,
                    Length startPositionX,
                    Length startPositionY,
                    Length startPositionZ)

Constructs a SpatialQueue at the specific position. Beside of the spatial extension the behaviors and the functionalities of the SpatialQueue remain the same as the Queue. For more information about the Queue, and the constructor, please see desmoj.core.simulator.Queue<E>

Parameters:

owner - The model this queue is associated to.

name - The queue's name.

visualModel - The visual model attribute belongs to the SpatialObject interface.

sortOrder - determines the sort order of the underlying queue implementation. Choose a constant from QueueBased like QueueBased.FIFO or QueueBased.LIFO or ...

qCapacity - The capacity of the Queue, that is how many entities can be enqueued. Zero (0) means unlimited capacity.

showInReport - Flag if queue should produce a report.

showInTrace - Flag for queue to produce trace messages.

startPositionX - The x-coordinate of the start position.

startPositionY - The y-coordinate of the start position.

startPositionZ - The z-coordinate of the start position.

Method Detail

addEntryPoint

public void addEntryPoint(java.lang.String name,
                          Length xPos,
                          Length yPos,
                          Length zPos)

Description copied from interface: SpatialObject

Adds an entry point to this SpatialObject. The given position should refer to the local coordinates of this SpatialObject.

Specified by:

addEntryPoint in interface SpatialObject

Parameters:

name - The name of this entry point.

xPos - The x-position of this entry point in local coordinates.

yPos - The y-position of this entry point in local coordinates.

zPos - The z-position of this entry point in local coordinates.

addExitPoint

public void addExitPoint(java.lang.String name,
                         Length xPos,
                         Length yPos,
                         Length zPos)

Description copied from interface: SpatialObject

Adds an exit point to this SpatialObject. The given position should refer to the local coordinates of this SpatialObject.

Specified by:

addExitPoint in interface SpatialObject

Parameters:

name - The name of this exit point.

xPos - The x-position of this exit point in local coordinates.

yPos - The y-position of this exit point in local coordinates.

zPos - The z-position of this exit point in local coordinates.

getEntryPointNames

public java.util.Set<java.lang.String> getEntryPointNames()

Description copied from interface: SpatialObject

Gets a set of names of all the entry points this SpatialObject contains.

Specified by:

getEntryPointNames in interface SpatialObject

Returns:

A set of names of the entry points.

getExitPointNames

public java.util.Set<java.lang.String> getExitPointNames()

Description copied from interface: SpatialObject

Gets a set of names of all the exit points this SpatialObject contains.

Specified by:

getExitPointNames in interface SpatialObject

Returns:

A set of names of the exit points.

getEntryPoint

public Length[] getEntryPoint(java.lang.String name)

Description copied from interface: SpatialObject

Gets the position of the given entry point.

Specified by:

getEntryPoint in interface SpatialObject

Parameters:

name - The name of the entry point.

Returns:

The position of the entry point in local coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the entry point with the given name.

getEntryPointGlobal

public Length[] getEntryPointGlobal(java.lang.String name)

Description copied from interface: SpatialObject

Gets the position of the entry point in global coordinates.

Specified by:

getEntryPointGlobal in interface SpatialObject

Parameters:

name - The name of the entry point.

Returns:

The position of the entry point in global coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the entry point with the given name.

getExitPoint

public Length[] getExitPoint(java.lang.String name)

Description copied from interface: SpatialObject

Gets the position of the given exit point.

Specified by:

getExitPoint in interface SpatialObject

Parameters:

name - The name of the exit point.

Returns:

The position of the exit point in local coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the exit point with the given name.

getExitPointGlobal

public Length[] getExitPointGlobal(java.lang.String name)

Description copied from interface: SpatialObject

Gets the position of the exit point in global coordinates.

Specified by:

getExitPointGlobal in interface SpatialObject

Parameters:

name - The name of the exit point.

Returns:

The position of the exit point in global coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the exit point with the given name.

getMatrix

public Matrix4d getMatrix()

Description copied from interface: SpatialObject

Gets a 4x4 double matrix object which contains the spatial data of the SpatialObejct.

Specified by:

getMatrix in interface SpatialObject

Returns:

The Matrix4d object.

getPosX

public Length getPosX()

Specified by:

getPosX in interface SpatialObject

Returns:

It returns the x-position of the object.

getPosY

public Length getPosY()

Specified by:

getPosY in interface SpatialObject

Returns:

It returns the y-position of the object.

getPosZ

public Length getPosZ()

Specified by:

getPosZ in interface SpatialObject

Returns:

It returns the z-position of the object.

getVisualModel

public java.lang.String getVisualModel()

Description copied from interface: VisibleObject

Get the type of the SpatialObject.

Specified by:

getVisualModel in interface VisibleObject

Returns:

The type of the SpatialObject.

isMovable

public boolean isMovable()

Description copied from interface: SpatialObject

Check whether this Object is a MovableSpatialObject or not.

Specified by:

isMovable in interface SpatialObject

Returns:

Return true if this SpatialObject is also a MovableSpatialObject. Else, false.

isVisible

public boolean isVisible()

Description copied from interface: VisibleObject

Shows the visibility of the visual representation of this object.

Specified by:

isVisible in interface VisibleObject

Returns:

True is this object is visible. Else, false.

removeVisible

public void removeVisible()

Description copied from interface: VisibleObject

Sends a RemoveEvent to signal the observers that this object isn't needed anymore.

WARNING: The SpatialObject will be still existing.

Specified by:

removeVisible in interface VisibleObject

resetRotation

public void resetRotation()

Description copied from interface: SpatialObject

Resets the rotation of the object.

Specified by:

resetRotation in interface SpatialObject

rotX

public void rotX(double angle)

Description copied from interface: SpatialObject

Adds a rotation about the x-axis to the current orientation.

Specified by:

rotX in interface SpatialObject

Parameters:

angle - The rotation angle in radians

rotY

public void rotY(double angle)

Description copied from interface: SpatialObject

Adds a rotation about the y-axis to the current orientation.

Specified by:

rotY in interface SpatialObject

Parameters:

angle - The rotation angle in radians

rotZ

public void rotZ(double angle)

Description copied from interface: SpatialObject

Adds a rotation about the z-axis to the current orientation.

Specified by:

rotZ in interface SpatialObject

Parameters:

angle - The rotation angle in radians

setPosition

public void setPosition(Length x,
                        Length y,
                        Length z)

Description copied from interface: SpatialObject

It sets the new position for the object. *

Specified by:

setPosition in interface SpatialObject

Parameters:

x - The ExtendedLength which contains the new x-position.

y - The ExtendedLength which contains the new y-position.

z - The ExtendedLength which contains the new z-position.

setVisible

public void setVisible(boolean visible)

Description copied from interface: VisibleObject

Sets the visibility of the visual representation of this object.

Specified by:

setVisible in interface VisibleObject

Parameters:

visible - True, if visible. Else, false.