desmoj.extensions.applicationDomains.harbour

Class Block

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.extensions.applicationDomains.harbour.Block

Direct Known Subclasses:

Yard

public class Block
extends Reportable

Block is the place where containers (or other kind of goods) can be stored by transpoters or cranes and retrieved by transporters or cranes. The storing is possible using store() of the Block. With the retrieve() a container can be retrieved from the Block. A Block is a part of the container Yard. There are no queues for processes want to store or retrieve one container. If no or not enough containers are available to retrieve, the tries to do that will be refused. The Block has a certain capacity that measures in TEUs. So a 20-foot-container weigths one TEU and 40-foot-container 2 TEUs. If the Block is filled to it's capacity the tries to store a container there will be refused. Yard is part of the composite design pattern as described in [Gamm97] page 163 in which it represents the the component class. Block is derived from Reportable, which provides the report functionality for the Block.

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:

Reportable

Constructor Summary

Constructors

Constructor and Description
Block(Model owner, java.lang.String name, int typ, long capacity, boolean showInReport, boolean showInTrace) Constructor for a Block of a certain typ with a certain capacity.
Block(Model owner, java.lang.String name, int typ, long capacity, long init, boolean showInReport, boolean showInTrace) Constructor for a Block with an initial number of TEUs and a certain capacity.
Block(Model owner, java.lang.String name, int typ, long capacity, long init, int ctyp, boolean showInReport, boolean showInTrace) Constructor for a Block with an initial number of TEUs, a certain capacity and a certain container typ.

Method Summary

Modifier and Type	Method and Description
double	avgCapacity() Returning the average number of TEUs available in the Block over the time since the last reset of the Block.
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this Block.
long	getCapacity() Gets the max. capacity of the Block.
long	getConsumers() Gets the number of the processes that retrieved from this Block.
int	getCTyp() Gets the container typ of the Block: what kind of container is that Block for.
long	getCurrentCapacity() Gets the current capacity of the Block.
HoldingArea	getHO() Gets the holding area this Block is assigned to.
long	getInitial() Gets the initial number of TEUs the Block starts with.
long	getMaximum() Gets the maximum number of TEUs in the Block.
long	getMinimum() Gets the minimum number of TEUs (goods) in the Block.
long	getProducers() Gets the number of the processes that stored in this Block.
int	getTyp() Gets the typ of the Block.
boolean	isFree(long n) Method to check if the Block is free (it can be stored there) for at least some TEUs.
double	OccupRate() Gets the occupation rate of the Block.
boolean	plan(long n) Method for consumers to make the Block plan a number of n TEUs (a place for a container) to be retrieved there later.
boolean	reserve(long n) Method for producers to make the Block reserve a number of n TEUs (a place for a container) to be stored there later.
void	reset() To reset the statistics of this Block.
boolean	retrieve(long n) Method for consumers to make the Block retrieve a number of n TEUs (a container).
void	setCTyp(int ctyp) Sets the container typ of this Block to a new value.
void	setHO(HoldingArea ho) Assigns this Block to a new holding area.
void	setTyp(int t) Sets the typ of this Block to a new value.
boolean	store(long n) Method for producers to make the Block store a number of n TEUs (a container).

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

Block

public Block(Model owner,
             java.lang.String name,
             int typ,
             long capacity,
             boolean showInReport,
             boolean showInTrace)

Constructor for a Block of a certain typ with a certain capacity.

Parameters:

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

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

typ - int : The Block's type. It can be only 0 - for export containers, 1- for import containers or 2 - mixed: for import and export containers.

capacity - long : The maximum capacity (TEU) of this Block.

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

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

Block

public Block(Model owner,
             java.lang.String name,
             int typ,
             long capacity,
             long init,
             boolean showInReport,
             boolean showInTrace)

Constructor for a Block with an initial number of TEUs and a certain capacity.

Parameters:

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

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

typ - int : The Block's type. It can be only 0 - for export containers, 1- for import containers or 2 - mixed: for import and export containers.

capacity - long : The maximum capacity of this Block.

init - long : The initial occupied capacity of the Block starts with. Must be positive!

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

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

Block

public Block(Model owner,
             java.lang.String name,
             int typ,
             long capacity,
             long init,
             int ctyp,
             boolean showInReport,
             boolean showInTrace)

Constructor for a Block with an initial number of TEUs, a certain capacity and a certain container typ.

Parameters:

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

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

typ - int : The Block's type. It can be only 0 - for export containers, 1- for import containers or 2 - mixed: for import and export containers.

capacity - long : The maximum capacity of this Block.

ctyp - int : The container type of this Block. It can be only 0- for empty, 1- for normal, 2- for reefer, 4- for overlarge, 5- for danger containers.

init - long : The initial occupied capacity of the Block starts with. Must be positive!

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

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

Method Detail

getMaximum

public long getMaximum()

Gets the maximum number of TEUs in the Block.

Returns:

long : The maximum number of TEUs in the Block.

getMinimum

public long getMinimum()

Gets the minimum number of TEUs (goods) in the Block.

Returns:

long : The minimum number of TEUs (goods) in the Block.

OccupRate

public double OccupRate()

Gets the occupation rate of the Block.

Returns:

double : The occupation rate of the Block.

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this Block.

Returns:

desmoj.report.Reporter : The Reporter reporting about the statistics of this Block.

store

public boolean store(long n)

Method for producers to make the Block store a number of n TEUs (a container). When the capacity of the block can not hold the additional incoming TEUs the try to store will be refused.

Parameters:

n - long : The weight of the container to be stored in this Block. n must be positive.

Returns:

boolean : Is true if the container can been stored successfully, false otherwise.

avgCapacity

public double avgCapacity()

Returning the average number of TEUs available in the Block over the time since the last reset of the Block.

Returns:

double : The average number of TEUs available in the Block over the time since the last reset of the Block.

retrieve

public boolean retrieve(long n)

Method for consumers to make the Block retrieve a number of n TEUs (a container). When the block is empty the try to retrieve will be refused.

Parameters:

n - long : The weight of the container to be stored in this Block. n must be positive.

Returns:

boolean : Is true if the container can been stored successfully, false otherwise.

getProducers

public long getProducers()

Gets the number of the processes that stored in this Block.

Returns:

long : producers number.

getConsumers

public long getConsumers()

Gets the number of the processes that retrieved from this Block.

Returns:

long : consumers number.

plan

public boolean plan(long n)

Method for consumers to make the Block plan a number of n TEUs (a place for a container) to be retrieved there later. When all the containers are already planed for the later retrieving the try to plan will be refused.

Parameters:

n - long : The number of TEUs that a container that is in the Block weights. n must be positive.

Returns:

boolean : Is true if a container can been planed successfully, false otherwise.

getInitial

public long getInitial()

Gets the initial number of TEUs the Block starts with.

Returns:

long : The initial number of TEUs the Block starts with.

reset

public void reset()

To reset the statistics of this Block. The current capacity and the number of avalaible TEUs for the storing and retrieving, reserving and planing are not changed. But all statistic counters are reset. The Reportable is also reset.

Overrides:

reset in class Reportable

isFree

public boolean isFree(long n)

Method to check if the Block is free (it can be stored there) for at least some TEUs.

Parameters:

n - long : The number of TEUs that are at least must be avalaible (free).

Returns:

boolean : Is true if the Block is free, false otherwise.

getTyp

public int getTyp()

Gets the typ of the Block.

Returns:

long : The typ of the Stock.

setTyp

public void setTyp(int t)

Sets the typ of this Block to a new value.

Parameters:

t - int : The new typ of this Block.

reserve

public boolean reserve(long n)

Method for producers to make the Block reserve a number of n TEUs (a place for a container) to be stored there later. When the whole available capacity is already reserved the try to reserve will be refused.

Parameters:

n - long : The number of TEUs that are needed for a container to be stored in the Block. n must be positive.

Returns:

boolean : Is true if a place for a container can been reserved successfully, false otherwise.

getCapacity

public long getCapacity()

Gets the max. capacity of the Block.

Returns:

long : The capacity of the Block.

getCurrentCapacity

public long getCurrentCapacity()

Gets the current capacity of the Block.

Returns:

long : The current capacity of the Block.

setHO

public void setHO(HoldingArea ho)

Assigns this Block to a new holding area.

Parameters:

ho - HoldingArea: The new holding area of this Block.

getHO

public HoldingArea getHO()

Gets the holding area this Block is assigned to.

Returns:

HoldingArea: The Holding area the Block is assigned to.

setCTyp

public void setCTyp(int ctyp)

Sets the container typ of this Block to a new value.

Parameters:

ctyp - int : The new container typ of this Block.

getCTyp

public int getCTyp()

Gets the container typ of the Block: what kind of container is that Block for.

Returns:

long : The container typ of the Block.