Source code for conflowgen.domain_models.distribution_models.container_dwell_time_distribution

from __future__ import annotations

from peewee import FloatField, CompositeKey, TextField

from conflowgen.domain_models.data_types.mode_of_transport import ModeOfTransport
from conflowgen.domain_models.data_types.storage_requirement import StorageRequirement
from conflowgen.domain_models.base_model import BaseModel
from conflowgen.domain_models.field_types.mode_of_transport import ModeOfTransportField
from conflowgen.domain_models.field_types.storage_requirement import StorageRequirementField




class ContainerDwellTimeDistributionInterface:

    #: The vehicle type the box is delivered by.
    delivered_by: ModeOfTransport

    #: The vehicle type the box is picked up by.
    picked_up_by: ModeOfTransport

    #: The storage requirement of the box.
    storage_requirement: StorageRequirement

    #: The distribution to use in that specific case.
    distribution_name: str

    #: To avoid unrealistic short times, values shorter than this are not drawn from the distribution.
    minimum_number_of_hours: float

    #: To avoid unrealistic long times, values longer than this are not drawn from the distribution.
    maximum_number_of_hours: float

    #: The average number of hours is the expected mean of the distribution.
    average_number_of_hours: float

    #: The variance is a distribution-specific parameter and helps to instantiate, e.g., normal or lognormal
    #: distributions.
    variance: float | None



class ContainerDwellTimeDistribution(BaseModel, ContainerDwellTimeDistributionInterface):
    """
    The container dwell time distribution describes how long the container remains in the yard.
    """
    # The key - when to apply the distribution
    delivered_by = ModeOfTransportField(null=False)
    picked_up_by = ModeOfTransportField(null=False)
    storage_requirement = StorageRequirementField(null=False)

    # short name of the distribution class
    distribution_name = TextField(null=False)

    # distribution properties
    minimum_number_of_hours = FloatField(default=0)
    maximum_number_of_hours = FloatField(default=None)
    average_number_of_hours = FloatField(default=None)
    variance = FloatField(default=None)

    class Meta:
        primary_key = CompositeKey('delivered_by', 'picked_up_by', 'storage_requirement')