Yard (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.core.simulator.NamedObject
- - desmoj.core.simulator.ModelComponent
  - - desmoj.core.simulator.Reportable
    - - desmoj.extensions.applicationDomains.harbour.Block
      - desmoj.extensions.applicationDomains.harbour.Yard

```
public class Yard
extends Block
```
Yard is the place where containers (or other kind of goods) can be stored by transpoters or cranes and retrieved by transporters or cranes. The yard consists of blocks. The storing in the Yard is possible using store(Block b) .With the retrieve(Block b) a container can be retrieved from the Yard. Yard is part of the composite design pattern as described in [Gamm97] page 163. Yard is derived from Block, which provides the functionality of 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:

Block

Constructor Summary

Constructors
Constructor and Description
`Yard(Model owner, java.lang.String name, ChooseBlockYardStrategy s, boolean showInReport, boolean showInTrace)` Constructor for a Yard.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlock(Block b)` Method for producers to make the Yard add a block.
`Reporter`	`createDefaultReporter()` Returns a Reporter to produce a report about this Yard.
`Block[]`	`getAllBlocks()` Gets all the blocks of the yard.
`Block`	`getBlock(Block[] blocks)` Gets the Block of the yard that was found by using the current yard strategy of the yard.
`Block[]`	`getBlocks(int typ)` Gets all the blocks of the yard that have the certain typ.
`Block[]`	`getBlocks(int typ, Block[] b)` Gets all the blocks of a part of the yard that have the certain typ.
`Block[]`	`getCBlocks(int ctyp)` Gets all the blocks of the yard with a certain container typ.
`Block[]`	`getFreeBlocks(Block[] b, long n)` Gets all the blocks from a part of the yard blocks that have some free place to store containers.
`Block[]`	`getFreeBlocks(long n)` Gets all the blocks of the yard that have some free place to store containers.
`Block[]`	`getFullBlocks(Block[] b, long n)` Gets all the blocks of the yard that have at least some TEUs (not empty).
`Block[]`	`getHOBlocks(HoldingArea ho)` Gets all the blocks of the yard that are assigned a certain holding area to.
`int`	`getNumBlocks()` Returns the number of all the blocks of this yard.
`long`	`getOverflow()` Gets the current number of TEUs/containers in the overflow part of this yard.
`ChooseBlockYardStrategy`	`getYardStrategy()` Returns the strategy of this yard for the choosing of a block.
`boolean`	`isFree(long n)` Method to check if the Yard is free (there's at least one block that is free).
`boolean`	`plan(Block b, long n)` Method for consumers to make the Yard plan a number of n TEUs (a place for a container) to be retrieved there later.
`boolean`	`reserve(Block b, long n)` Method for producers to make the Yard reserve a number of n TEUs (a place for a container) to be stored there later.
`void`	`reset()` To reset the statistics of this Yard.
`boolean`	`retrieve(Block b, long n)` Method for consumers to make the Yard retrieve a number of n TEUs (a container).
`boolean`	`retrieveFromOverflow(long n)` Method for consumers to retrieve from the overflow part of this Yard a number of n TEUs (a container).
`void`	`setYardStrategy(ChooseBlockYardStrategy s)` Sets strategy of this yard for the choosing of a block to a new value.
`boolean`	`store(Block b, long n)` Method for producers to make the Yard store a number of n TEUs (a container).
`void`	`storeInOverflow(long n)` Method for producers to make the Yard store a number of n TEUs (a container) in its overflow part.

Methods inherited from class desmoj.extensions.applicationDomains.harbour.Block
avgCapacity, getCapacity, getConsumers, getCTyp, getCurrentCapacity, getHO, getInitial, getMaximum, getMinimum, getProducers, getTyp, OccupRate, plan, reserve, retrieve, setCTyp, setHO, setTyp, store

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
  - Yard
```
public Yard(Model owner,
            java.lang.String name,
            ChooseBlockYardStrategy s,
            boolean showInReport,
            boolean showInTrace)
```
    Constructor for a Yard.
    
    Parameters:
    
    owner - desmoj.Model : The model this Yard is associated to.
    
    name - java.lang.String : The Yard'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.
- Method Detail
  - createDefaultReporter
```
public Reporter createDefaultReporter()
```
    Returns a Reporter to produce a report about this Yard.
    
    Overrides:
    
    createDefaultReporter in class Block
    
    Returns:
    
    desmoj.report.Reporter : The Reporter reporting about the statistics of this Yard.
  - addBlock
```
public void addBlock(Block b)
```
    Method for producers to make the Yard add a block. This is only allowed as long as the Yard has not been used or the Yard has just been reset.
    
    Parameters:
    
    b - Block : The Block that must be added to this yard.
  - getBlocks
```
public Block[] getBlocks(int typ)
```
    Gets all the blocks of the yard that have the certain typ.
    
    Parameters:
    
    typ - int : The typ of the blocks.
    
    Returns:
    
    Block[]: The Blocks of the yard of a certain typ.
  - getBlocks
```
public Block[] getBlocks(int typ,
                         Block[] b)
```
    Gets all the blocks of a part of the yard that have the certain typ.
    
    Parameters:
    
    typ - int : The typ of the blocks.
    
    b - Block[] : The array of the certain blocks of the yard.
    
    Returns:
    
    Block[]: The Blocks of the yard of a certain typ.
  - getFreeBlocks
```
public Block[] getFreeBlocks(long n)
```
    Gets all the blocks of the yard that have some free place to store containers.
    
    Parameters:
    
    n - long : The number of TEUs that are at least must be avalaible (free) in that blocks.
    
    Returns:
    
    Block[]: The Blocks of the yard that have some free place.
  - getFreeBlocks
```
public Block[] getFreeBlocks(Block[] b,
                             long n)
```
    Gets all the blocks from a part of the yard blocks that have some free place to store containers.
    
    Parameters:
    
    b - Block[] : The array of the certain blocks of the yard.
    
    Returns:
    
    Block[]: The Blocks of the yard that have some free place.
  - getAllBlocks
```
public Block[] getAllBlocks()
```
    Gets all the blocks of the yard.
    
    Returns:
    
    Block[]: The Blocks of the yard.
  - getBlock
```
public Block getBlock(Block[] blocks)
```
    Gets the Block of the yard that was found by using the current yard strategy of the yard.
    
    Returns:
    
    Block: The Block of the yard found by using yard strategy.
  - storeInOverflow
```
public void storeInOverflow(long n)
```
    Method for producers to make the Yard store a number of n TEUs (a container) in its overflow part.
    
    Parameters:
    
    n - long : The weight of the container to be stored in the overflow part of this yard. n must be positive.
  - retrieveFromOverflow
```
public boolean retrieveFromOverflow(long n)
```
    Method for consumers to retrieve from the overflow part of this Yard a number of n TEUs (a container).
    
    Parameters:
    
    n - long : The weight of the container to be stored in the overflow part of this yard. n must be positive.
    
    Returns:
    
    boolean : Is true if the try was successfull, false otherwise.
  - store
```
public boolean store(Block b,
                     long n)
```
    Method for producers to make the Yard store a number of n TEUs (a container). When the capacity of the yard can not hold the additional incoming TEUs the try to store will be refused.
    
    Parameters:
    
    b - Block : The block of the yard to store.
    
    n - long : The weight of the container to be stored in this Yard. n must be positive.
    
    Returns:
    
    boolean : Is true if the container can been stored successfully, false otherwise.
  - retrieve
```
public boolean retrieve(Block b,
                        long n)
```
    Method for consumers to make the Yard retrieve a number of n TEUs (a container). When the yard is empty the try to retrieve will be refused.
    
    Parameters:
    
    b - Block : The block of the yard to retrieve.
    
    n - long : The weight of the container to be stored in this Yard. n must be positive.
    
    Returns:
    
    boolean : Is true if the container can been stored successfully, false otherwise.
  - getOverflow
```
public long getOverflow()
```
    Gets the current number of TEUs/containers in the overflow part of this yard.
    
    Returns:
    
    long : The current capacity of te overflow part of the yard.
  - isFree
```
public boolean isFree(long n)
```
    Method to check if the Yard is free (there's at least one block that is free).
    
    Overrides:
    
    isFree in class Block
    
    Parameters:
    
    n - long : The number of TEUs that are at least must be avalaible (free) in the Yard.
    
    Returns:
    
    boolean : Is true if the Yard is free, false otherwise.
  - reserve
```
public boolean reserve(Block b,
                       long n)
```
    Method for producers to make the Yard 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:
    
    b - Block : The block of the yard to reserve.
    
    n - long : The number of TEUs that are needed for a container to be stored in the Yard. n must be positive.
    
    Returns:
    
    boolean : Is true if a place for a container can been reserved successfully, false otherwise.
  - plan
```
public boolean plan(Block b,
                    long n)
```
    Method for consumers to make the Yard 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:
    
    b - Block : The block of the yard to plan.
    
    n - long : The number of TEUs that a container that is in the Yard weights. n must be positive.
    
    Returns:
    
    boolean : Is true if a container can been planed successfully, false otherwise.
  - getNumBlocks
```
public int getNumBlocks()
```
    Returns the number of all the blocks of this yard.
    
    Returns:
    
    int : The number of the yard blocks.
  - setYardStrategy
```
public void setYardStrategy(ChooseBlockYardStrategy s)
```
    Sets strategy of this yard for the choosing of a block to a new value.
    
    Parameters:
    
    s - ChooseBlockYardStrategy : The new yard strategy.
  - getYardStrategy
```
public ChooseBlockYardStrategy getYardStrategy()
```
    Returns the strategy of this yard for the choosing of a block.
    
    Returns:
    
    ChooseBlockYardStrategy: The yard strategy.
  - reset
```
public void reset()
```
    To reset the statistics of this Yard. The statistics of all yard blocks will be reset too.
    
    Overrides:
    
    reset in class Block
  - getHOBlocks
```
public Block[] getHOBlocks(HoldingArea ho)
```
    Gets all the blocks of the yard that are assigned a certain holding area to.
    
    Parameters:
    
    ho - HoldingArea: The holding area that the blocks are assigned to.
    
    Returns:
    
    Block[]: The Blocks of the yard of a certain holding area.
  - getCBlocks
```
public Block[] getCBlocks(int ctyp)
```
    Gets all the blocks of the yard with a certain container typ.
    
    Parameters:
    
    ctyp - int : The typ of the contaners of this block.
    
    Returns:
    
    Block[]: The Blocks of the yard of a certain container typ.
  - getFullBlocks
```
public Block[] getFullBlocks(Block[] b,
                             long n)
```
    Gets all the blocks of the yard that have at least some TEUs (not empty).
    
    Parameters:
    
    n - long : The number of TEUs that are at least must be with containers in the blocks of the yard.
    
    Returns:
    
    Block[]: The Blocks of the yard that are not empty.

Class Yard

Constructor Summary

Method Summary

Methods inherited from class desmoj.extensions.applicationDomains.harbour.Block

Methods inherited from class desmoj.core.simulator.Reportable

Methods inherited from class desmoj.core.simulator.ModelComponent

Methods inherited from class desmoj.core.simulator.NamedObject

Methods inherited from class java.lang.Object

Constructor Detail

Yard

Method Detail

createDefaultReporter

addBlock

getBlocks

getBlocks

getFreeBlocks

getFreeBlocks

getAllBlocks

getBlock

storeInOverflow

retrieveFromOverflow

store

retrieve

getOverflow

isFree

reserve

plan

getNumBlocks

setYardStrategy

getYardStrategy

reset

getHOBlocks

getCBlocks

getFullBlocks