desmoj.extensions.applicationDomains.harbour

Class CranesSystem

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.QueueBased

desmoj.extensions.applicationDomains.harbour.CranesSystem

All Implemented Interfaces:

Subject<QueueBased,QueueBased.QueueAction>

public class CranesSystem
extends QueueBased

A CranesSystem represents the system of the cranes that manages the queues of the cranes and transporter (external/internal), give the statistics about the cranes and both queues.

Version:

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

Author:

Eugenia Neufeld 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.

See Also:

QueueBased

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
CranesSystem(Model owner, java.lang.String name, int cSortOrder, int cQCapacity, int tSortOrder, int tQCapacity, boolean showInReport, boolean showInTrace) Constructor for a CranesSystem.

Method Summary

Modifier and Type	Method and Description
boolean	addCrane(Crane c) This method is used to add a crane to the cranes queue of this CranesSystem.
void	addSumLoadTime(double t) Change the whole time that all the cranes needed to load the transporters to a new value.
void	addSumNumLoadedUnits(long n) Change the number of the loaded units of all the cranes to a new value.
void	addSumNumUnloadedUnits(long n) Change the number of the unloaded units of all the cranes to a new value.
void	addSumUnloadTime(double t) Change the whole time that all the cranes needed to unload the transporters to a new value.
boolean	addTransporter(SimProcess t) This method is used to add a transporter (external/internal) to the transporter queue of this CranesSystem.
double	avgUsage() Returns the average utilization of a crane of this cranes system.
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this CranesSystem.
Crane[]	getCranes(int n) Returns the n cranes of this cranes system that are idle now.
ProcessQueue<Crane>	getCranesQueue() Returns the cranes queue of this cranes system.
double	getSumLoadTime() Returns the whole loading time of all the cranes.
long	getSumNumLoadedUnits() Returns the number of the loaded units of all the cranes.
long	getSumNumUnloadedUnits() Returns the number of the unloaded units of all the cranes.
double	getSumUnloadTime() Returns the whole unloading time of all the cranes.
SimProcess	getTransporter() Returns the last transporter of the transporter queue.
ProcessQueue<SimProcess>	getTransporterQueue() Returns the transporter queue of this cranes system.
ProcessQueue<Crane>	getWorkingCranes() Returns the queue of the now working cranes of this cranes system.
void	reset() Resets all statistical counters to their default values.

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

CranesSystem

public CranesSystem(Model owner,
                    java.lang.String name,
                    int cSortOrder,
                    int cQCapacity,
                    int tSortOrder,
                    int tQCapacity,
                    boolean showInReport,
                    boolean showInTrace)

Constructor for a CranesSystem. The queueing discipline and the capacity limit of the underlying queues for the cranes and for the transporters can be chosen.

Parameters:

owner - Model : The model this CranesSystem is associated to.

name - java.lang.String : The CranesSystem's name

csortOrder - int : determines the sort order of the underlying cranes queue implementation. Choose a constant from QueueBased like QueueBased.FIFO or QueueBased.LIFO or ...

cQCapacity - int : The capacity of the cranes queue, that is how many cranes can be enqueued. Zero (0) means unlimited capacity.

tsortOrder - int : determines the sort order of the underlying transporter queue implementation. Choose a constant from QueueBased like QueueBased.FIFO or QueueBased.LIFO or ...

tQCapacity - int : The capacity of the transporter queue, that is how many transporters can be enqueued. Zero (0) means unlimited capacity.

showInReport - boolean : Flag, if this CranesSystem should produce a report or not.

showInTrace - boolean : Flag for trace to produce trace messages.

Method Detail

getSumNumLoadedUnits

public long getSumNumLoadedUnits()

Returns the number of the loaded units of all the cranes.

Returns:

long : The number of the loaded by the cranes units.

addSumNumLoadedUnits

public void addSumNumLoadedUnits(long n)

Change the number of the loaded units of all the cranes to a new value.

Parameters:

n - long : The number of loaded units of this CranesSystem that must be added to the old value.

getSumNumUnloadedUnits

public long getSumNumUnloadedUnits()

Returns the number of the unloaded units of all the cranes.

Returns:

long : The number of the unloaded by the cranes units.

addSumNumUnloadedUnits

public void addSumNumUnloadedUnits(long n)

Change the number of the unloaded units of all the cranes to a new value.

Parameters:

n - long : The number of unloaded units of this CranesSystem that must be added to the old value.

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this CranesSystem.

Returns:

desmoj.report.Reporter : The Reporter for the queues inside this CranesSystem.

addCrane

public boolean addCrane(Crane c)

This method is used to add a crane to the cranes queue of this CranesSystem.

Parameters:

c - Crane : The Crane to enqueue.

getCranes

public Crane[] getCranes(int n)

Returns the n cranes of this cranes system that are idle now.

Returns:

Crane[] : The idle cranes.

getCranesQueue

public ProcessQueue<Crane> getCranesQueue()

Returns the cranes queue of this cranes system.

Returns:

ProcessQueue: The cranes queue.

getTransporterQueue

public ProcessQueue<SimProcess> getTransporterQueue()

Returns the transporter queue of this cranes system.

Returns:

ProcessQueue: The transporter queue.

reset

public void reset()

Resets all statistical counters to their default values. Both, cranes queue and transporter queue are reset. The mininum and maximum length of the queues are set to the current number of queued objects.

Overrides:

reset in class QueueBased

addTransporter

public boolean addTransporter(SimProcess t)

This method is used to add a transporter (external/internal) to the transporter queue of this CranesSystem.

Parameters:

t - SimProcess: The transporter that me be enqueued.

getTransporter

public SimProcess getTransporter()

Returns the last transporter of the transporter queue.

Returns:

SimProcess : The last transporter of the transporter queue.

avgUsage

public double avgUsage()

Returns the average utilization of a crane of this cranes system.

Returns:

double : The average utilisation pro a crane.

getSumLoadTime

public double getSumLoadTime()

Returns the whole loading time of all the cranes.

Returns:

double : The whole loading time of this cranes system.

getSumUnloadTime

public double getSumUnloadTime()

Returns the whole unloading time of all the cranes.

Returns:

double : The whole unloading time of this cranes system.

addSumLoadTime

public void addSumLoadTime(double t)

Change the whole time that all the cranes needed to load the transporters to a new value.

Parameters:

t - double : The loading time of this CranesSystem that must be added to the old value.

addSumUnloadTime

public void addSumUnloadTime(double t)

Change the whole time that all the cranes needed to unload the transporters to a new value.

Parameters:

t - double : The unloading time of this CranesSystem that must be added to the old value.

getWorkingCranes

public ProcessQueue<Crane> getWorkingCranes()

Returns the queue of the now working cranes of this cranes system.

Returns:

ProcessQueue: The queue of the working cranes.