drone_cab.assign

Assignment utilities.

Collection of functions that assign various entities to other entities.

Functions

assign_package_pickup(package, pickup_list)

Attempt to assign a pickup point to the given package.

assign_package_vehicle(package, ...)

Attempt to assign a vehicle to the given package.
drone_cab.assign.assign_package_pickup(package: Package, pickup_list: list[Pickup]) → Pickup | None

Attempt to assign a pickup point to the given package.

Parameters:

  • package (Package) – Package obejct to attenpt assignment of pickup point to.

  • pickup_list (list[Pickup]) – List of pickup point objects to choose the pickup point from.

Returns:

Assigned pickup object if successful, else None.

Return type:

Pickup | None

drone_cab.assign.assign_package_vehicle(package: Package, vehicle_list: list[Vehicle], warehouse: Warehouse) → Vehicle | None

Attempt to assign a vehicle to the given package.

Parameters:

  • package (Package) – Package obejct to attenpt assignment of vehicle to.

  • vehicle_list (list[Vehicle]) – List of vehicle objects to choose the vehicle from.

  • warehouse (Warehouse) – Warehouse object from where the vehicle will pick up the package.

Returns:

Assigned vehicle object if successful, else None.

Raises:

AssertionError – If given package does not have an assigned pickup point.

Return type:

Vehicle | None