desmoj.extensions.applicationDomains.harbour

Class TransporterSystem

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.QueueBased

desmoj.extensions.applicationDomains.harbour.TransporterSystem

All Implemented Interfaces:

Subject<QueueBased,QueueBased.QueueAction>

public class TransporterSystem
extends QueueBased

A TransporterSystem represents the system of the transporters that manages the queues of the transporter and jobs, give the statistics about the transporters 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
TransporterSystem(Model owner, java.lang.String name, int tSortOrder, int tQCapacity, int jSortOrder, int jQCapacity, boolean showInReport, boolean showInTrace) Constructor for a TransporterSystem.

Method Summary

Modifier and Type	Method and Description
boolean	addJob(Job j) This method is used to add the job to the jobs queue of this TransporterSystem.
void	addSumDistanceEmptyDrives(double d) Change the whole distance of the empty drives of all the transporters to a new value.
void	addSumDistanceLoadedDrives(double d) Change the whole distance of the loaded drives of all the transporters to a new value.
void	addSumNumEmptyDrives(long n) Change the number of the empty drives of all the transporters to a new value.
void	addSumNumLoadedDrives(long n) Change the number of the loaded drives of all the transporters to a new value.
void	addSumTimeEmptyDrives(double t) Change the whole time of the empty drives of all the transporters to a new value.
void	addSumTimeLoadedDrives(double t) Change the whole time of the loaded drives of all the transporters to a new value.
boolean	addTransporter(InternalTransporter t) This method is used to add an internal transporter to the transporter queue of this TransporterSystem.
double	avgUsage() Returns the average utilization of a transporter of this transporter system.
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this TransporterSystem.
InternalTransporter[]	getAssignedTransporter(Crane c) Returns all the at the moment idle transporters of a certain crane they are assigned to.
InternalTransporter[]	getFreeTransporter(int n) Returns n idle transporters of this transporter system that have still no crane that are assigned to.
Queue	getJobs() Returns the jobs queue of this transporter system.
java.lang.String	getJobsQueueStrategy() Returns the implemented queueing discipline of the underlying queue for jobs as a String, so it can be displayed in the report.
double	getSumDistanceEmptyDrives() Returns the whole distance of the empty drives of all the transporters.
double	getSumDistanceLoadedDrives() Returns the whole distance of the loaded drives of all the transporters.
long	getSumNumEmptyDrives() Returns the number of the empty drives of all the transporters.
long	getSumNumLoadedDrives() Returns the number of the loaded drives of all the transporters.
double	getSumTimeEmptyDrives() Returns the whole time of the empty drives of all the transporters.
double	getSumTimeLoadedDrives() Returns the whole time of the loaded drives of all the transporters.
ProcessQueue	getTransporter() Returns the transporter queue of this transporter system.
java.lang.String	getTransporterQueueStrategy() Returns the implemented queueing discipline of the underlying queue for transporters as a String, so it can be displayed in the report.
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

TransporterSystem

public TransporterSystem(Model owner,
                         java.lang.String name,
                         int tSortOrder,
                         int tQCapacity,
                         int jSortOrder,
                         int jQCapacity,
                         boolean showInReport,
                         boolean showInTrace)

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

Parameters:

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

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

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.

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

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

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

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

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this TransporterSystem.

Returns:

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

addJob

public boolean addJob(Job j)

This method is used to add the job to the jobs queue of this TransporterSystem.

Parameters:

t - Job: The Job that me be enqueued.

addTransporter

public boolean addTransporter(InternalTransporter t)

This method is used to add an internal transporter to the transporter queue of this TransporterSystem.

Parameters:

t - Job: The InternalTransporter that must be enqueued.

reset

public void reset()

Resets all statistical counters to their default values. Both, transporter queue and job 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

getSumNumEmptyDrives

public long getSumNumEmptyDrives()

Returns the number of the empty drives of all the transporters.

Returns:

long : The number of the empty drives.

addSumNumEmptyDrives

public void addSumNumEmptyDrives(long n)

Change the number of the empty drives of all the transporters to a new value.

Parameters:

n - long : The number of empty drives of this TransporterSystem that must be added to the old value.

addSumTimeEmptyDrives

public void addSumTimeEmptyDrives(double t)

Change the whole time of the empty drives of all the transporters to a new value.

Parameters:

t - double : The time of empty drives of this TransporterSystem that must be added to the old value.

getSumTimeEmptyDrives

public double getSumTimeEmptyDrives()

Returns the whole time of the empty drives of all the transporters.

Returns:

double : The whole time of the empty drives.

addSumDistanceEmptyDrives

public void addSumDistanceEmptyDrives(double d)

Change the whole distance of the empty drives of all the transporters to a new value.

Parameters:

d - double : The whole distance of the empty drives of this TransporterSystem that must be added to the old value.

getSumDistanceEmptyDrives

public double getSumDistanceEmptyDrives()

Returns the whole distance of the empty drives of all the transporters.

Returns:

double : The whole distance of the empty drives.

addSumDistanceLoadedDrives

public void addSumDistanceLoadedDrives(double d)

Change the whole distance of the loaded drives of all the transporters to a new value.

Parameters:

d - double : The whole distance of the loaded drives of this TransporterSystem that must be added to the old value.

getSumDistanceLoadedDrives

public double getSumDistanceLoadedDrives()

Returns the whole distance of the loaded drives of all the transporters.

Returns:

double : The whole distance of the loaded drives.

getSumNumLoadedDrives

public long getSumNumLoadedDrives()

Returns the number of the loaded drives of all the transporters.

Returns:

long : The number of the loaded drives.

addSumNumLoadedDrives

public void addSumNumLoadedDrives(long n)

Change the number of the loaded drives of all the transporters to a new value.

Parameters:

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

addSumTimeLoadedDrives

public void addSumTimeLoadedDrives(double t)

Change the whole time of the loaded drives of all the transporters to a new value.

Parameters:

t - double : The whole time of loaded drives of this TransporterSystem that must be added to the old value.

getSumTimeLoadedDrives

public double getSumTimeLoadedDrives()

Returns the whole time of the loaded drives of all the transporters.

Returns:

double : The whole time of the loaded drives.

avgUsage

public double avgUsage()

Returns the average utilization of a transporter of this transporter system.

Returns:

double : The average utilisation.

getTransporter

public ProcessQueue getTransporter()

Returns the transporter queue of this transporter system.

Returns:

ProcessQueue: The transporter queue.

getJobs

public Queue getJobs()

Returns the jobs queue of this transporter system.

Returns:

Queue: The jobs queue.

getTransporterQueueStrategy

public java.lang.String getTransporterQueueStrategy()

Returns the implemented queueing discipline of the underlying queue for transporters as a String, so it can be displayed in the report.

Returns:

String : The String indicating the queueing discipline.

getJobsQueueStrategy

public java.lang.String getJobsQueueStrategy()

Returns the implemented queueing discipline of the underlying queue for jobs as a String, so it can be displayed in the report.

Returns:

String : The String indicating the queueing discipline.

getFreeTransporter

public InternalTransporter[] getFreeTransporter(int n)

Returns n idle transporters of this transporter system that have still no crane that are assigned to.

Returns:

InternalTransporter[] : The idle internal transporters.

getAssignedTransporter

public InternalTransporter[] getAssignedTransporter(Crane c)

Returns all the at the moment idle transporters of a certain crane they are assigned to.

Parameters:

c - Crane: The crane that these transportes are assigned to.

Returns:

InternalTransporter[] : The idle internal transporters of a certain crane.