desmoj.extensions.applicationDomains.harbour

Class Crane

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.harbour.Crane

public abstract class Crane
extends SimProcess

A Crane represents any kind of cranes (containerbridges, gantry crane) which loads/unloads containers(goods) onto/from an external/internal transporter or into/from yard in a container terminal. Crane is derived from SimProcess. Its lifeCycle() must be implemented to spezify the behavior of the Crane.

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:

SimProcess, C_Control

Constructor Summary

Constructors

Constructor and Description
Crane(Model owner, java.lang.String name, C_Control cs, boolean showInTrace) Constructs a Crane which will loads/unloads containers(goods) onto/from an external/internal transporter or into/from yard in a container terminal.
Crane(Model owner, java.lang.String name, int bufferCapacity, C_Control cs, boolean showInTrace) Constructs a Crane which will loads/unloads containers(goods) onto/from an external/internal transporter or into/from yard in a container terminal.

Method Summary

Modifier and Type	Method and Description
void	drive(TimeSpan time) This method describes the driving of the crane ( crane speader).
Stock	getBuffer() Returns the buffer of this crane.
C_Control	getCS() Returns the crane control this crane belongs to.
double	getLoadTime() Returns the whole loading time of this crane.
long	getNumLoadedUnits() Returns the number of the units that this Crane has loaded.
long	getNumToLoadUnits() Returns the number of the units this crane has to load.
long	getNumToUnloadUnits() Returns the number of the units this crane has to unload.
long	getNumUnloadedUnits() Returns the number of the units that this Crane has unloaded.
Ship	getShip() Returns the ship this Crane is assigned to.
double	getUnloadTime() Returns the whole unloading time of this crane.
WaitQueue	getWLoadQueue() Returns the queue where this Crane waits to load an internal transporter.
WaitQueue	getWUnloadQueue() Returns the queue where this Crane waits to unload an internal transporter.
boolean	load(Loading loading) This method describes the loading action of this crane if has to wait for an internal transporter before loading it.
void	load(TimeSpan time) This method describes the loading action of this crane.
void	reset() To reset the statistics about unloaded und loaded units of this Crane.
void	setBuffer(Stock b) Sets the buffer of this crane to a new value.
void	setCS(C_Control cs) Sets the crane control of this crane to a new value.
void	setNumToLoadUnits(long n) Sets the number of the units this crane to has to load.
void	setNumToUnloadUnits(long n) Sets the number of the units this crane to has to unload.
void	setShip(Ship s) Sets the ship this crane is assigned to.
void	setWLoadQueue(WaitQueue wq) Sets the queue where this crane waits for an internal transpoter to load it to a new value.
void	setWUnloadQueue(WaitQueue wq) Sets the queue where this crane waits for an internal transpoter to unload it to a new value.
void	unload(TimeSpan time) This method describes the unloading action of this crane.
boolean	unload(Unloading unloading) This method describes the unloading action of this crane if has to wait for an internal transporter before unloading it.
boolean	waitOnLoading() This method must be used by an internal transporter if he wants to be loaded by this crane.
boolean	waitOnUnloading() This method must be used by an internal transporter if he wants to be unloaded by this crane.

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, lifeCycle, 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

Crane

public Crane(Model owner,
             java.lang.String name,
             int bufferCapacity,
             C_Control cs,
             boolean showInTrace)

Constructs a Crane which will loads/unloads containers(goods) onto/from an external/internal transporter or into/from yard in a container terminal. Implement its lifeCycle method to specify its behavior.

Parameters:

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

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

bufferCapacity - int : The maximum number of containers(goods) this Crane can store in its buffer.

cs - C_Control: The crane control which this Crane belongs to.

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

Crane

public Crane(Model owner,
             java.lang.String name,
             C_Control cs,
             boolean showInTrace)

Constructs a Crane which will loads/unloads containers(goods) onto/from an external/internal transporter or into/from yard in a container terminal. Implement its lifeCycle method to specify its behavior.

Parameters:

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

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

cs - C_Control: The crane control which this Crane belongs to.

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

Method Detail

load

public void load(TimeSpan time)
          throws SuspendExecution

This method describes the loading action of this crane. In this simple case only the time it takes to load a container (an unit). The number and time of loaded units were counted in this method.

Parameters:

time - TimeSpan : The loading time.

Throws:

SuspendExecution

unload

public void unload(TimeSpan time)
            throws SuspendExecution

This method describes the unloading action of this crane. In this simple case only the time it takes to unload a container (an unit). The number and time of unloaded units were counted in this method.

Parameters:

time - TimeSpan : The unloading time.

Throws:

SuspendExecution

drive

public void drive(TimeSpan time)
           throws SuspendExecution

This method describes the driving of the crane ( crane speader). In this simple case only the time it takes to drive.

Parameters:

time - TimeSpan : The time to drive.

Throws:

SuspendExecution

getNumLoadedUnits

public long getNumLoadedUnits()

Returns the number of the units that this Crane has loaded.

Returns:

long : The number of the loaded of this Crane.

getNumUnloadedUnits

public long getNumUnloadedUnits()

Returns the number of the units that this Crane has unloaded.

Returns:

long : The number of the unloaded of this Crane.

reset

public void reset()

To reset the statistics about unloaded und loaded units of this Crane.

setShip

public void setShip(Ship s)

Sets the ship this crane is assigned to.

Parameters:

s - Ship : The new ship for this crane .

getShip

public Ship getShip()

Returns the ship this Crane is assigned to.

Returns:

Ship: The ship of this Crane.

getCS

public C_Control getCS()

Returns the crane control this crane belongs to.

Returns:

C_Control: The crane control of this Crane.

setCS

public void setCS(C_Control cs)

Sets the crane control of this crane to a new value.

Parameters:

cs - C_Control: The new crane control for this crane.

getBuffer

public Stock getBuffer()

Returns the buffer of this crane.

Returns:

Stock: The buffer of this Crane.

setBuffer

public void setBuffer(Stock b)

Sets the buffer of this crane to a new value.

Parameters:

b - Stock: The new buffer for this crane.

getNumToLoadUnits

public long getNumToLoadUnits()

Returns the number of the units this crane has to load.

Returns:

long : The number of the units this crane has to load.

getNumToUnloadUnits

public long getNumToUnloadUnits()

Returns the number of the units this crane has to unload.

Returns:

long : The number of the units this crane has to unload.

setNumToLoadUnits

public void setNumToLoadUnits(long n)

Sets the number of the units this crane to has to load.

Parameters:

n - long : The number of the units this crane has to load.

setNumToUnloadUnits

public void setNumToUnloadUnits(long n)

Sets the number of the units this crane to has to unload.

Parameters:

n - long : The number of the units this crane has to unload.

load

public boolean load(Loading loading)
             throws SuspendExecution

This method describes the loading action of this crane if has to wait for an internal transporter before loading it. In this simple case only the time it takes to load the internal transporter with the Loading action.

Parameters:

loading - Loading: The loading process.

Throws:

SuspendExecution

unload

public boolean unload(Unloading unloading)
               throws SuspendExecution

This method describes the unloading action of this crane if has to wait for an internal transporter before unloading it. In this simple case only the time it takes to unload the internal transporter with the Unloading action.

Parameters:

unloading - Unloading: The unloading process.

Throws:

SuspendExecution

waitOnUnloading

public boolean waitOnUnloading()
                        throws SuspendExecution

This method must be used by an internal transporter if he wants to be unloaded by this crane. If the crane is not idle, the internal trasnporter will wait by the crane for his unloading.

Throws:

SuspendExecution

waitOnLoading

public boolean waitOnLoading()
                      throws SuspendExecution

This method must be used by an internal transporter if he wants to be loaded by this crane. If the crane is not idle, the internal trasnporter will wait by the crane for his loading.

Throws:

SuspendExecution

getWLoadQueue

public WaitQueue getWLoadQueue()

Returns the queue where this Crane waits to load an internal transporter.

Returns:

WaitQueue: The waiting load queue of this Crane.

getWUnloadQueue

public WaitQueue getWUnloadQueue()

Returns the queue where this Crane waits to unload an internal transporter.

Returns:

WaitQueue: The waiting unload queue of this Crane.

setWLoadQueue

public void setWLoadQueue(WaitQueue wq)

Sets the queue where this crane waits for an internal transpoter to load it to a new value.

Parameters:

wq - WaitQueue: The waiting load queue for this crane .

setWUnloadQueue

public void setWUnloadQueue(WaitQueue wq)

Sets the queue where this crane waits for an internal transpoter to unload it to a new value.

Parameters:

wq - WaitQueue: The waiting unload queue for this crane .

getLoadTime

public double getLoadTime()

Returns the whole loading time of this crane.

Returns:

double : The whole loading time of this Crane.

getUnloadTime

public double getUnloadTime()

Returns the whole unloading time of this crane.

Returns:

double : The whole unloading time of this Crane.