Enumerations

This module contains all enumerations used in the project. This enables a structured set of options and values for the user to choose from. The module contains enumerations for the different modes that are tracked, the key performance indicators that are calculated, the tracked locations and the supply chain configurations (LogisticType). Also, custom exceptions are defined to handle errors in the simulation.

exception logsim.enumerations.ComponentConfigurationError

Bases: Exception

Configuration not aligned with create components.

class logsim.enumerations.KPIModes(value)

Bases: Enum

This enumeration defines the combination of KPI enumeration values that define a KPI value. These will be combined in the calculation of the KPIs and added up.

ON_DP = [2, 3]

OPERATING = [2, 3, 7, 8, 12, 13]

SAILING = [4, 14, 15]

WAITING = [9, 11, 10, 5, 6, 16, 17, 18]

WAITING_FOR_WEATHER = [9, 11, 10]

WAITING_OTHER = [5, 6, 16, 17, 18]

class logsim.enumerations.Location(value)

Bases: IntEnum

The locations a vessel can be at

INTERMEDIATE_LOCATION = 3

NONE_LOCATION = 0

OFFSHORE = 5

SAILING = 4

SUPPLY_PORT = 1

WIND_FARM = 2

class logsim.enumerations.LogisticType(value)

Bases: Enum

Define the different logistic configurations. The numbers refer to the numbers as in the documentation overview of these different configurations

DIRECT_1 = 1

OFFSHORE_TRANSFER_2 = 3

OFFSHORE_TRANSFER_BUFFER_5 = 4

PORT_TRANSFER_3 = 2

PORT_TRANSSHIPMENT_4 = 5

class logsim.enumerations.Modes(value)

Bases: IntEnum

The tracked modes in the simulation

DOCKED = 1

ENTERING_PORT = 15

INSTALL = 2

LEAVING_PORT = 14

LOADING_FROM_SUPPLY = 7

MOORING = 12

NONE_MODE = 0

SAILING = 4

TRANSFER = 3

UNLOADING_FROM_SUPPLY = 8

UNMOORING = 13

WAITING_FOR_SUPPLY_AVAILABILITY = 17

WAITING_FROM_STORE = 6

WAITING_QUAY = 16

WAITING_REQUEST = 18

WAITING_TRANSFER = 5

WAITING_WEATHER_INSTALLING = 9

WAITING_WEATHER_SAILING = 11

WAITING_WEATHER_TRANSFER = 10

exception logsim.enumerations.NoWindowFoundError

Bases: Exception

No available window was found anymore, so max run time of 10000 hours reached

class logsim.enumerations.Resources(intermediate_quay)

Bases: tuple

intermediate_quay: Alias for field number 0

class logsim.enumerations.Stores(supply_vessels_alongside, foundations_at_supply, foundations_at_intermediate)

Bases: tuple

foundations_at_intermediate: Alias for field number 2

foundations_at_supply: Alias for field number 1

supply_vessels_alongside: Alias for field number 0