from __future__ import annotations
import datetime
from typing import Dict
from conflowgen.data_summaries.data_summaries_cache import DataSummariesCache
from conflowgen.descriptive_datatypes import OutboundUsedAndMaximumCapacity, ContainerVolumeByVehicleType
from conflowgen.domain_models.distribution_validators import validate_distribution_with_one_dependent_variable
from conflowgen.previews.abstract_preview import AbstractPreview
from conflowgen.domain_models.data_types.mode_of_transport import ModeOfTransport
from conflowgen.domain_models.distribution_repositories.mode_of_transport_distribution_repository import \
ModeOfTransportDistributionRepository
from conflowgen.application.services.inbound_and_outbound_vehicle_capacity_calculator_service import \
InboundAndOutboundVehicleCapacityCalculatorService
[docs]
class InboundAndOutboundVehicleCapacityPreview(AbstractPreview):
"""
This preview examines how much the inbound vehicles deliver to the terminal and how it is redistributed to the
outbound journeys of the other vehicles according to the mode of transport distribution.
This pre-checks whether the transport capacity of the vehicles will be exceeded.
In such case, the input schedules and distributions should be further refined before generating a container flow.
The preview returns a data structure that can be used for generating reports (e.g., in text or as a figure)
as it is the case with :class:`.InboundAndOutboundVehicleCapacityPreviewReport`.
The preview is intended to provide a first estimate before running the expensive
:meth:`.ContainerFlowGenerationManager.generate` method.
The preview does not consider all restrictions (such as container dwell times in combination with the schedules)
into consideration, thus later deviations might exist.
"""
def __init__(
self,
start_date: datetime.date,
end_date: datetime.date,
transportation_buffer: float
):
"""
Args:
start_date: The earliest day to consider when checking the vehicles that move according to schedules
end_date: The latest day to consider when checking the vehicles that move according to schedules
transportation_buffer: The fraction of how much more a vehicle takes with it on an outbound journey
compared to an inbound journey as long as the total vehicle capacity is not exceeded.
"""
super().__init__(
start_date=start_date,
end_date=end_date,
transportation_buffer=transportation_buffer
)
self.mode_of_transport_distribution = ModeOfTransportDistributionRepository().get_distribution()
@DataSummariesCache.cache_result
def _get_truck_capacity_for_export_containers(
self,
inbound_capacity_of_vehicles: Dict[ModeOfTransport, float]
) -> float:
"""
Get the capacity in TEU which is transported by truck. Currently, during the generation process each import
container is picked up by one truck and for each import container, in the next step one export container is
created.
Thus, this method accounts for both import and export.
"""
return InboundAndOutboundVehicleCapacityCalculatorService.\
get_truck_capacity_for_export_containers(inbound_capacity_of_vehicles)
[docs]
@DataSummariesCache.cache_result
def hypothesize_with_mode_of_transport_distribution(
self,
mode_of_transport_distribution: Dict[ModeOfTransport, Dict[ModeOfTransport, float]]
):
validate_distribution_with_one_dependent_variable(
mode_of_transport_distribution, ModeOfTransport, ModeOfTransport, values_are_frequencies=True
)
self.mode_of_transport_distribution = mode_of_transport_distribution
[docs]
@DataSummariesCache.cache_result
def get_inbound_capacity_of_vehicles(self) -> ContainerVolumeByVehicleType:
"""
For the inbound capacity, first vehicles that adhere to a schedule are considered. Trucks, which are created
depending on the outbound distribution, are created based on the assumptions of the further container flow
generation process.
"""
return InboundAndOutboundVehicleCapacityCalculatorService.\
get_inbound_capacity_of_vehicles(self.start_date, self.end_date)
[docs]
@DataSummariesCache.cache_result
def get_outbound_capacity_of_vehicles(self) -> OutboundUsedAndMaximumCapacity:
"""
For the outbound capacity, both the used outbound capacity (estimated) and the maximum outbound capacity is
reported. If a vehicle type reaches the maximum outbound capacity, this means that containers need to be
redistributed to other vehicle types due to a lack of capacity. The capacities are only calculated in TEU, not
in containers.
"""
return InboundAndOutboundVehicleCapacityCalculatorService.\
get_outbound_capacity_of_vehicles(self.start_date, self.end_date, self.transportation_buffer)