Actions

The main 4 actions

class automatic_warehouse.simulation.actions.action.Action(env: Environment, warehouse: Warehouse, simulation)

Superclass for all actions.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

get_env() → Environment

Get the simulation environment (see SimPy Environment).

Return type:

simpy.Environment

Returns:

the simulation environment.

get_simulation()

Get the simulation where the action is performed.

Return type:

Simulation

Returns:

the simulation where the action is performed.

get_warehouse()

Get the warehouse where the action is performed.

Return type:

Warehouse

Returns:

the warehouse where the action is performed.

abstract simulate_action(tray: Tray = None, destination: EnumContainer = None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.action_enum.ActionEnum(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Enumerate of the possible actions.

EXTRACT_TRAY = 'ExtractTray'

Extract Tray action.

INSERT_RANDOM_MATERIAL = 'InsertRandomMaterial'

Insert Random Material action.

REMOVE_RANDOM_MATERIAL = 'RemoveRandomMaterial'

Remove Random Material action.

SEND_BACK_TRAY = 'SendBackTray'

Send Back Tray action.

static from_str(action_str: str) → Enum | None

Static method from string.

Return type:

ActionEnum | None

Parameters:

action_str (str) – action as string.

Returns:

the ActionEnum or None.

class automatic_warehouse.simulation.actions.buffer.Buffer(env: Environment, warehouse: Warehouse, simulation: Simulation)

The buffer action is the movement from the buffer entry to the bay entry.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.material.insert_material.insert_material.InsertMaterial(env: Environment, warehouse: Warehouse, simulation: Simulation, duration: int)

A superclass of insert material action.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

• duration (int) – the duration of the action in seconds.

get_duration() → int

Get the duration of the action in seconds.

Return type:

int

Returns:

the duration of the action in seconds.

abstract simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.material.remove_material.remove_material.RemoveMaterial(env: Environment, warehouse: Warehouse, simulation: Simulation, duration: int)

A superclass of remove material action.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

• duration (int) – the duration of the action in seconds.

get_duration() → int

Get the duration of the action in seconds.

Return type:

int

Returns:

the duration of the action in seconds.

abstract simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.material.insert_material.insert_random_material.InsertRandomMaterial(env: Environment, warehouse: Warehouse, simulation: Simulation, duration: int)

The insert random material action is the movement performed by the person who has put a material from his hand to the bay.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

• duration (int) – the duration of the action in seconds.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.material.remove_material.remove_random_material.RemoveRandomMaterial(env: Environment, warehouse: Warehouse, simulation: Simulation, duration: int)

The remove random material action is the movement performed by the person who has removed a material from the bay to their hand.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

• duration (int) – the duration of the action in seconds.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.extract_tray.ExtractTray(env: Environment, warehouse: Warehouse, simulation: Simulation)

The extract of a tray (ExtractTray action) is the movement from a column to the bay.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.send_back_tray.SendBackTray(env: Environment, warehouse: Warehouse, simulation: Simulation)

The send-back of a tray (SendBackTray action) is the movement of a tray from the bay to one of the columns.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

Basic movements

class automatic_warehouse.simulation.actions.move.move.Move(env: Environment, warehouse: Warehouse, simulation: Simulation)

Superclass for all simple moves.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

get_buffer() → Buffer

Get the buffer pointer, useful during simulation.

:rtype Buffer :return: the buffer pointer.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.move.go_to_bay.GoToBay(env: Environment, warehouse: Warehouse, simulation: Simulation)

Movement to go to the bay.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.move.go_to_buffer.GoToBuffer(env: Environment, warehouse: Warehouse, simulation: Simulation)

Movement to go to the buffer.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.move.load.Load(env: Environment, warehouse: Warehouse, simulation: Simulation)

Horizontal movement from the center of the lift to the center of the column.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.move.unload.Unload(env: Environment, warehouse: Warehouse, simulation: Simulation)

Horizontal movement from the center of the column to the center of the lift.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).

class automatic_warehouse.simulation.actions.move.vertical.Vertical(env: Environment, warehouse: Warehouse, simulation: Simulation)

Vertical movement.

Parameters:

• env (Environment) – the simulation environment (SimPy Environment).

• warehouse (Warehouse) – the warehouse where the action is performed.

• simulation (Simulation) – the simulation where the action is performed.

simulate_action(tray=None, destination=None)

Method that simulates the action of the instance.

Parameters:

• tray (Tray) – A tray used in the simulation, sometimes it is not useful (e.g. GoToBay).

• destination (EnumContainer) – A destination used in the simulation, sometimes it is not useful (e.g. GoToBay).