desmoj.extensions.applicationDomains.harbour

Class InternalTransporter

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.Entity

desmoj.core.simulator.SimProcess

desmoj.extensions.applicationDomains.production.Transporter

desmoj.extensions.applicationDomains.harbour.InternalTransporter

public abstract class InternalTransporter
extends Transporter

A InternalTransporter represents any kind of vehicle (AGV, VC, chassis) which carries goods (containers) around in a container terminal. It has a certain loaded and empty speed when he drives in a terminal and is loaded or empty. He has also a certain transporter control which he gets his Job to do by. InternalTransporter is derived from Transporter. Because of that he has a certain capacity (maximum number of goods which can be carried around at once) and a minimum load (minimum number of goods which will be carried) that one is. Its lifeCycle() is already implemented and spezifies the behavior of the InternalTransporter. But its methods importJobCycle(Job j) and ExportJobCycle(Job j) must be ipmlemented by the user in order to specify the behavior of the InternalTransporter if he does an emport or export job.

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:

Transporter, T_Control, Job

Constructor Summary

Constructors

Constructor and Description
InternalTransporter(Model owner, java.lang.String name, int capac, double speedLoad, double speedEmpty, T_Control ts, boolean showInTrace) Constructs an Internal Transporter which will carry around containers (goods) in a container terminal.

Method Summary

Modifier and Type	Method and Description
void	driveEmpty(double distance) This method describes the driving the certain distance of the internal transporter if he is empty (has no goods).
void	driveLoad(double distance) This method describes the driving the certain distance of the internal transporter if he is loaded (has some goods).
abstract void	exportJobCycle(Job j) Override this method in a subclass of InternalTransporter to implement that internal transporter's specific behaviour if he has to do an export job in a container terminal.
Crane	getCrane() Returns the crane (containerbridge) which this InternalTransporter is assigned to.
int	getCurrentCapacity() Returns the current capacity of this InternalTransporter.
Job	getJob() Returns the current job of this InternalTransporter.
long	getNumEmptyDrives() Returns the number of empty drives that this InternalTransporter has done.
long	getNumLoadedDrives() Returns the number of loaded drives that this InternalTransporter has done.
double	getSpeedEmpty() Returns the empty speed of this InternalTransporter.
double	getSpeedLoad() Returns the loaded speed of this InternalTransporter.
double	getTimeEmptyDrives() Returns the whole time of empty drives that this InternalTransporter has done.
double	getTimeLoadedDrives() Returns the whole time of loaded drives that this InternalTransporter has done.
abstract void	importJobCycle(Job j) Override this method in a subclass of InternalTransporter to implement that internal transporter's specific behaviour if he has to do an import job in a container terminal.
void	lifeCycle() This method implements the internal transporter specific behaviour.
void	pickDown(TimeSpan time) This method describes the unloading of the internal transporter.
void	pickUp(TimeSpan time) This method describes the loading of the internal transporter.
void	reset() To reset all the statistics about this InternalTransporter.
void	setCrane(Crane c) Sets the crane that this InternalTransporter must be assigned to.
void	setCurrentCapacity(int c) Sets the current capacity of this InternalTransporter to a new value.
void	setJob(Job j) Sets the job of this InternalTransporter that he has to do.
void	setSpeedEmpty(double s) Sets the empty speed of this InternalTransporter to a new value.
void	setSpeedLoad(double s) Sets the loaded speed of this InternalTransporter to a new value.

Methods inherited from class desmoj.extensions.applicationDomains.production.Transporter

getCapacity, getMinLoad, setCapacity, setMinLoad

Methods inherited from class desmoj.core.simulator.SimProcess

activate, activate, activate, activateAfter, activateBefore, activatePreempt, cancelInterruptDelayed, canCooperate, clearInterruptCode, cooperate, getActivatedBy, getInterruptCode, getInterruptException, getMaster, getRealTimeConstraint, getSchedulingPriority, getSlaveWaitQueue, getSupervisor, hold, hold, hold, interrupt, interrupt, interruptDelayed, interruptDelayed, isBlocked, isComponent, isDelayedInterruptScheduled, isInterrupted, isRepeating, isTerminated, obtainResources, passivate, prepareTransport, reActivate, reActivate, resetMaster, returnAllResources, returnResources, setBlocked, setRealTimeConstraint, setRepeating, setSchedulingPriority, setSlaveWaitQueue

Methods inherited from class desmoj.core.simulator.Entity

getIdentNumber, getQueueingPriority, getQueues, getScheduledEvents, isEqual, isLarger, isLargerOrEqual, isNotEqual, isQueued, isSimProcess, isSmaller, isSmallerOrEqual, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, scheduleAfter, scheduleAfter, scheduleAfter, scheduleBefore, scheduleBefore, scheduleBefore, schedulePreempt, schedulePreempt, schedulePreempt, setQueueingPriority

Methods inherited from class desmoj.core.simulator.Schedulable

assignReporter, cancel, getCorrespondingReportable, isCurrent, isScheduled, rename, reSchedule, reSchedule, reSchedulePreempt, scheduledNext, setCorrespondingReportable

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

InternalTransporter

public InternalTransporter(Model owner,
                           java.lang.String name,
                           int capac,
                           double speedLoad,
                           double speedEmpty,
                           T_Control ts,
                           boolean showInTrace)

Constructs an Internal Transporter which will carry around containers (goods) in a container terminal. Implement its importJobCycle(Job j) method and exportJobCycle(Job j) to specify its behavior when he gets an ex- or import job. An Internal Transporter has like a Transporter a capacity (maximum number of goods which can be transported) and a mimimum load ( a minimum number of goods it will carry). Both must not be zero or negative. The capacity default value is one. The minimum load has always value one.

Parameters:

owner - desmoj.Model : The model this InternalTransporter is associated to.

name - java.lang.String : The name of this InternalTransporter.

capac - int : The maximum number of goods this InternalTransporter can carry around.

speedLoad - double : The loaded speed of this InternalTransporter.

speedEmpty - double : The empty speed of this InternalTransporter.

ts - T_Control: The transporter control wchich this InternalTransporter belongs to.

showInTrace - boolean : Flag, if this InternalTransporter should produce a trace output or not.

See Also:

It has a certain loaded and empty speed when he drives in a terminal and is loaded or empty. Both must not be zero or negative. He has also a certain transporter control which he gets his job to do by.

Method Detail

getCrane

public Crane getCrane()

Returns the crane (containerbridge) which this InternalTransporter is assigned to.

Returns:

Crane: The assigned crane of this InternalTransporter.

setCrane

public void setCrane(Crane c)

Sets the crane that this InternalTransporter must be assigned to.

Parameters:

c - Crane: The new assigned crane of this InternalTransporter.

driveLoad

public void driveLoad(double distance)
               throws SuspendExecution

This method describes the driving the certain distance of the internal transporter if he is loaded (has some goods). In this simple case only the time it takes to drive the distance with his loaded speed. The number and time of loaded drives were counted in this method.

Parameters:

distance - double : The distance to drive

Throws:

SuspendExecution

driveEmpty

public void driveEmpty(double distance)
                throws SuspendExecution

This method describes the driving the certain distance of the internal transporter if he is empty (has no goods). In this simple case only the time it takes to drive the distance with his empty speed. The number and time of empty drives were counted in this method.

Parameters:

distance - double : The distance to drive

Throws:

SuspendExecution

setSpeedEmpty

public void setSpeedEmpty(double s)

Sets the empty speed of this InternalTransporter to a new value. The new value must not be zero or negative.

Parameters:

s - double : The new empty speed of this InternalTransporter.

getSpeedEmpty

public double getSpeedEmpty()

Returns the empty speed of this InternalTransporter.

Returns:

double : The empty speed of this InternalTransporter.

setSpeedLoad

public void setSpeedLoad(double s)

Sets the loaded speed of this InternalTransporter to a new value. The new value must not be zero or negative.

Parameters:

s - double : The new loaded speed of this InternalTransporter.

getSpeedLoad

public double getSpeedLoad()

Returns the loaded speed of this InternalTransporter.

Returns:

double : The loaded speed of this InternalTransporter.

setJob

public void setJob(Job j)

Sets the job of this InternalTransporter that he has to do.

Parameters:

j - Job: The new job of this InternalTransporter.

getJob

public Job getJob()

Returns the current job of this InternalTransporter.

Returns:

Job: The job of this InternalTransporter.

setCurrentCapacity

public void setCurrentCapacity(int c)

Sets the current capacity of this InternalTransporter to a new value. The new value must not be negative.

Parameters:

c - int : The new current capacity of this InternalTransporter.

getCurrentCapacity

public int getCurrentCapacity()

Returns the current capacity of this InternalTransporter. That is the number of goods (containers) he carries at the moment.

Returns:

int : The current capacity of this InternalTransporter.

importJobCycle

public abstract void importJobCycle(Job j)
                             throws SuspendExecution

Override this method in a subclass of InternalTransporter to implement that internal transporter's specific behaviour if he has to do an import job in a container terminal.

Parameters:

j - Job: The import job of this InternalTransporter.

Throws:

SuspendExecution

exportJobCycle

public abstract void exportJobCycle(Job j)
                             throws SuspendExecution

Override this method in a subclass of InternalTransporter to implement that internal transporter's specific behaviour if he has to do an export job in a container terminal.

Parameters:

j - Job: The export job of this InternalTransporter.

Throws:

SuspendExecution

lifeCycle

public void lifeCycle()
               throws SuspendExecution

This method implements the internal transporter specific behaviour. This behavior is always the same therefore there is no need to implement that in a subclass of InternalTransporter. This method starts after an internal transporter has been created and activated by the scheduler.

Specified by:

lifeCycle in class Transporter

Throws:

SuspendExecution

getNumEmptyDrives

public long getNumEmptyDrives()

Returns the number of empty drives that this InternalTransporter has done.

Returns:

long : The number of empty drives of this InternalTransporter.

getNumLoadedDrives

public long getNumLoadedDrives()

Returns the number of loaded drives that this InternalTransporter has done.

Returns:

long : The number of loaded drives of this InternalTransporter.

getTimeEmptyDrives

public double getTimeEmptyDrives()

Returns the whole time of empty drives that this InternalTransporter has done.

Returns:

long : The whole time of empty drives of this InternalTransporter.

getTimeLoadedDrives

public double getTimeLoadedDrives()

Returns the whole time of loaded drives that this InternalTransporter has done.

Returns:

long : The whole time of loaded drives of this InternalTransporter.

pickUp

public void pickUp(TimeSpan time)
            throws SuspendExecution

This method describes the loading of the internal transporter. In this simple case only the time it takes to load a container/good on itself.

Parameters:

time - TimeSpan : The needed time to load.

Throws:

SuspendExecution

pickDown

public void pickDown(TimeSpan time)
              throws SuspendExecution

This method describes the unloading of the internal transporter. In this simple case only the time it takes to unload a good/container from itself.

Parameters:

time - TimeSpan : The needed time to unload.

Throws:

SuspendExecution

reset

public void reset()

To reset all the statistics about this InternalTransporter.