Merge pull request #90 from matsim-vsp/nrichter_thesis

Example class and Assigner, LSP-Plan written out each iteration
moia-oss · May 4, 2023 · 2cbe61c · 2cbe61c
2 parents fdd437c + e336abf
commit 2cbe61c
Show file tree

Hide file tree

Showing 41 changed files with 446 additions and 65 deletions.
diff --git a/src/main/java/example/lsp/initialPlans/ExampleSchedulingOfTransportChainHubsVsDirect.java b/src/main/java/example/lsp/initialPlans/ExampleSchedulingOfTransportChainHubsVsDirect.java
@@ -397,7 +397,7 @@ private static LSP createInitialLSP(Scenario scenario, SolutionType solutionType
 	private static List<LSPResource> createResourcesListFromLSPPlan(LSPPlan lspPlanWithReloading) {
 		log.info("Collecting all LSPResources from the LSPPlan");
 		List<LSPResource> resourcesList = new ArrayList<>();            //TODO: Mahe daraus ein Set, damit jede Resource nur einmal drin ist? kmt Feb22
-		for (LogisticChain solution : lspPlanWithReloading.getLogisticChain()) {
+		for (LogisticChain solution : lspPlanWithReloading.getLogisticChains()) {
 			for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
 				resourcesList.add(solutionElement.getResource());
 			}

diff --git a/src/main/java/example/lsp/initialPlans/ExampleTwoChains.java b/src/main/java/example/lsp/initialPlans/ExampleTwoChains.java
@@ -0,0 +1,306 @@
+package example.lsp.initialPlans;
+
+import example.lsp.multipleChains.Utils;
+import lsp.*;
+import lsp.shipment.LSPShipment;
+import lsp.shipment.ShipmentUtils;
+import lsp.usecase.UsecaseUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.matsim.api.core.v01.Id;
+import org.matsim.api.core.v01.Scenario;
+import org.matsim.api.core.v01.network.Link;
+import org.matsim.api.core.v01.network.Network;
+import org.matsim.contrib.freight.FreightConfigGroup;
+import org.matsim.contrib.freight.carrier.*;
+import org.matsim.contrib.freight.controler.CarrierScoringFunctionFactory;
+import org.matsim.contrib.freight.controler.CarrierStrategyManager;
+import org.matsim.contrib.freight.controler.FreightUtils;
+import org.matsim.core.config.CommandLine;
+import org.matsim.core.config.Config;
+import org.matsim.core.config.ConfigUtils;
+import org.matsim.core.controler.AbstractModule;
+import org.matsim.core.controler.Controler;
+import org.matsim.core.controler.OutputDirectoryHierarchy;
+import org.matsim.core.replanning.GenericPlanStrategyImpl;
+import org.matsim.core.replanning.selectors.BestPlanSelector;
+import org.matsim.core.scenario.ScenarioUtils;
+import org.matsim.core.utils.io.IOUtils;
+import org.matsim.examples.ExamplesUtils;
+import org.matsim.vehicles.VehicleType;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+public class ExampleTwoChains {
+
+	//TODO: Run Settings
+	private static final double TOLL_VALUE = 0;
+
+	private static final Logger log = LogManager.getLogger(ExampleTwoChains.class);
+
+	private static final Id<Link> DEPOT_SOUTH_LINK_ID = Id.createLinkId("i(1,0)");
+	private static final Id<Link> DEPOT_NORTH_LINK_ID = Id.createLinkId("i(1,8)");
+
+	private static final VehicleType VEH_TYPE_LARGE_50 = CarrierVehicleType.Builder.newInstance(Id.create("large50", VehicleType.class))
+			.setCapacity(50)
+			.setMaxVelocity(10)
+			.setFixCost(100)
+			.setCostPerDistanceUnit(0.01)
+			.setCostPerTimeUnit(0.01)
+			.build();
+
+	private ExampleTwoChains() {
+	} // so it cannot be instantiated
+
+	public static void main(String[] args) {
+		log.info("Prepare config");
+		Config config = prepareConfig(args);
+
+		log.info("Prepare scenario");
+		Scenario scenario = prepareScenario(config);
+
+		log.info("Prepare controler");
+		Controler controler = new Controler(scenario);
+		controler.addOverridingModule(new AbstractModule() {
+			@Override
+			public void install() {
+				install(new LSPModule());
+			}
+		});
+
+		controler.addOverridingModule(new AbstractModule() {
+			@Override
+			public void install() {
+//				bind( CarrierScoringFunctionFactory.class ).toInstance( new MyCarrierScorer());
+				final MyEventBasedCarrierScorer carrierScorer = new MyEventBasedCarrierScorer();
+				carrierScorer.setToll(TOLL_VALUE);
+
+				bind(CarrierScoringFunctionFactory.class).toInstance(carrierScorer);
+				bind(CarrierStrategyManager.class).toProvider(() -> {
+					CarrierStrategyManager strategyManager = FreightUtils.createDefaultCarrierStrategyManager();
+					strategyManager.addStrategy(new GenericPlanStrategyImpl<>(new BestPlanSelector<>()), null, 1);
+					return strategyManager;
+				});
+				bind( LSPStrategyManager.class ).toProvider(() -> {
+					LSPStrategyManager strategyManager = new LSPStrategyManagerImpl();
+					strategyManager.addStrategy(new GenericPlanStrategyImpl<>(new BestPlanSelector<>()), null, 1);
+					return strategyManager;
+				});
+				bind(LSPScorerFactory.class).toInstance( () -> new MyLSPScorer());
+			}
+		});
+
+		log.info("Run MATSim");
+		controler.run();
+
+		new LSPPlanXmlWriter(LSPUtils.getLSPs(controler.getScenario())).write(controler.getConfig().controler().getOutputDirectory() + "/lsps.xml");
+		new LSPPlanXmlReader(LSPUtils.getLSPs(controler.getScenario()), FreightUtils.getCarriers(controler.getScenario()));
+		new CarrierPlanWriter(FreightUtils.getCarriers(controler.getScenario())).write(controler.getConfig().controler().getOutputDirectory() + "/carriers.xml");
+
+		log.info("Some results ....");
+
+		for (LSP lsp : LSPUtils.getLSPs(controler.getScenario()).getLSPs().values()) {
+			UsecaseUtils.printScores(controler.getControlerIO().getOutputPath(), lsp);
+			UsecaseUtils.printShipmentsOfLSP(controler.getControlerIO().getOutputPath(), lsp);
+			UsecaseUtils.printResults_shipmentPlan(controler.getControlerIO().getOutputPath(), lsp);
+			UsecaseUtils.printResults_shipmentLog(controler.getControlerIO().getOutputPath(), lsp);
+		}
+		log.info("Done.");
+	}
+
+	private static Config prepareConfig(String[] args) {
+		Config config = ConfigUtils.createConfig();
+		if (args.length != 0) {
+			for (String arg : args) {
+				log.warn(arg);
+			}
+			ConfigUtils.applyCommandline(config,args);
+			CommandLine cmd = ConfigUtils.getCommandLine(args);
+		} else {
+			config.controler().setOutputDirectory("output/2chains");
+			config.controler().setLastIteration(2);
+		}
+		config.network().setInputFile(String.valueOf(IOUtils.extendUrl(ExamplesUtils.getTestScenarioURL("freight-chessboard-9x9"), "grid9x9.xml")));
+		config.controler().setOverwriteFileSetting(OutputDirectoryHierarchy.OverwriteFileSetting.overwriteExistingFiles);
+		config.controler().setWriteEventsInterval(1);
+
+		FreightConfigGroup freightConfig = ConfigUtils.addOrGetModule(config, FreightConfigGroup.class);
+		freightConfig.setTimeWindowHandling(FreightConfigGroup.TimeWindowHandling.ignore);
+
+		return config;
+	}
+
+	private static Scenario prepareScenario(Config config) {
+		Scenario scenario = ScenarioUtils.loadScenario(config);
+
+		for (Link link : scenario.getNetwork().getLinks().values()) {
+			link.setFreespeed(30 / 3.6);
+			link.setCapacity(1000);
+		}
+
+		log.info("Add LSP to the scenario");
+		LSPUtils.addLSPs(scenario, new LSPs(Collections.singletonList(createLSP(scenario))));
+
+		return scenario;
+	}
+
+	private static LSP createLSP(Scenario scenario) {
+		log.info("create LSP");
+		Network network = scenario.getNetwork();
+
+		LSPPlan lspPlan_oneChain;
+		{
+			log.info("Create lspPlan with one chain");
+
+			Carrier directCarrier = CarrierUtils.createCarrier(Id.create("directCarrier", Carrier.class));
+			directCarrier.getCarrierCapabilities().setFleetSize(CarrierCapabilities.FleetSize.INFINITE);
+
+			CarrierUtils.addCarrierVehicle(directCarrier, CarrierVehicle.newInstance(Id.createVehicleId("directTruck"), DEPOT_SOUTH_LINK_ID, VEH_TYPE_LARGE_50));
+			LSPResource directCarrierRessource = UsecaseUtils.DistributionCarrierResourceBuilder.newInstance(directCarrier, network)
+					.setDistributionScheduler(UsecaseUtils.createDefaultDistributionCarrierScheduler())
+					.build();
+
+			LogisticChainElement directCarrierElement = LSPUtils.LogisticChainElementBuilder.newInstance(Id.create("directCarrierLSE", LogisticChainElement.class))
+					.setResource(directCarrierRessource)
+					.build();
+
+
+			LogisticChain solution_direct = LSPUtils.LogisticChainBuilder.newInstance(Id.create("directSolution", LogisticChain.class))
+					.addLogisticChainElement(directCarrierElement)
+					.build();
+
+			final ShipmentAssigner singleSolutionShipmentAssigner = UsecaseUtils.createSingleLogisticChainShipmentAssigner();
+			lspPlan_oneChain = LSPUtils.createLSPPlan()
+					.addLogisticChain(solution_direct)
+					.setAssigner(singleSolutionShipmentAssigner);
+		}
+
+
+		LSPPlan lspPlan_twoChains;
+//		LSPPlan lspPlan_oneChain;
+		{
+			log.info("Create lspPlan with two chains");
+
+			LogisticChainElement southCarrierElement;
+			{
+				Carrier carrierSouth = CarrierUtils.createCarrier(Id.create("carrierSouth", Carrier.class));
+				carrierSouth.getCarrierCapabilities().setFleetSize(CarrierCapabilities.FleetSize.INFINITE);
+
+				CarrierUtils.addCarrierVehicle(carrierSouth, CarrierVehicle.newInstance(Id.createVehicleId("directTruck"), DEPOT_SOUTH_LINK_ID, VEH_TYPE_LARGE_50));
+				LSPResource carrierSouthResource = UsecaseUtils.DistributionCarrierResourceBuilder.newInstance(carrierSouth, network)
+						.setDistributionScheduler(UsecaseUtils.createDefaultDistributionCarrierScheduler())
+						.build();
+
+				southCarrierElement = LSPUtils.LogisticChainElementBuilder.newInstance(Id.create("southCarrierLSE", LogisticChainElement.class))
+						.setResource(carrierSouthResource)
+						.build();
+			}
+
+			LogisticChainElement northCarrierElement;
+			{
+				Carrier carrierNorth = CarrierUtils.createCarrier(Id.create("CarrierNorth", Carrier.class));
+				carrierNorth.getCarrierCapabilities().setFleetSize(CarrierCapabilities.FleetSize.INFINITE);
+
+				CarrierUtils.addCarrierVehicle(carrierNorth, CarrierVehicle.newInstance(Id.createVehicleId("directTruck"), DEPOT_NORTH_LINK_ID, VEH_TYPE_LARGE_50));
+				LSPResource carrierNorthResource = UsecaseUtils.DistributionCarrierResourceBuilder.newInstance(carrierNorth, network)
+						.setDistributionScheduler(UsecaseUtils.createDefaultDistributionCarrierScheduler())
+						.build();
+
+				northCarrierElement = LSPUtils.LogisticChainElementBuilder.newInstance(Id.create("northCarrierLSE", LogisticChainElement.class))
+						.setResource(carrierNorthResource)
+						.build();
+			}
+
+
+			// Building a south and north Logistic chain
+			LogisticChain southChain = LSPUtils.LogisticChainBuilder.newInstance(Id.create("southChain", LogisticChain.class))
+					.addLogisticChainElement(southCarrierElement)
+					.build();
+
+			LogisticChain northChain = LSPUtils.LogisticChainBuilder.newInstance(Id.create("northChain", LogisticChain.class))
+					.addLogisticChainElement(northCarrierElement)
+					.build();
+
+			LogisticChain oneChain = LSPUtils.LogisticChainBuilder.newInstance(Id.create("oneChain", LogisticChain.class))
+					.addLogisticChainElement(southCarrierElement)
+					.build();
+
+			final ShipmentAssigner shipmentAssigner = Utils.createAnyNumberLogisticChainShipmentAssigner();
+			lspPlan_twoChains = LSPUtils.createLSPPlan()
+					.addLogisticChain(southChain)
+					.addLogisticChain(northChain)
+					.setAssigner(shipmentAssigner);
+
+//			final shipmentAssigner singleShipmentAssigner = UsecaseUtils.createSingleLogisticChainShipmentAssigner();
+//			lspPlan_oneChain = LSPUtils.createLSPPlan()
+//					.addLogisticChain(oneChain)
+//					.setAssigner(shipmentAssigner);
+		}
+
+		List<LSPPlan> lspPlans = new ArrayList<>();
+		lspPlans.add(lspPlan_twoChains);
+		lspPlans.add(lspPlan_oneChain);
+
+		LSP lsp = LSPUtils.LSPBuilder.getInstance(Id.create("myLSP", LSP.class))
+				.setInitialPlan(lspPlan_twoChains)
+				.setLogisticChainScheduler(UsecaseUtils.createDefaultSimpleForwardLogisticChainScheduler(createResourcesListFromLSPPlans(lspPlans)))
+				.build();
+		lsp.addPlan(lspPlan_oneChain);
+
+		log.info("create initial LSPShipments");
+		log.info("assign the shipments to the LSP");
+		for (LSPShipment shipment : createInitialLSPShipments(network)) {
+			lsp.assignShipmentToLSP(shipment);
+		}
+
+		log.info("schedule the LSP with the shipments and according to the scheduler of the Resource");
+		lsp.scheduleLogisticChains();
+
+		return lsp;
+	}
+
+	private static Collection<LSPShipment> createInitialLSPShipments(Network network) {
+		List<LSPShipment> shipmentList = new ArrayList<>();
+
+		int capacityDemand = 1;
+
+		Id<LSPShipment> shipmentSouthId = Id.create("shipmentSouth", LSPShipment.class);
+		ShipmentUtils.LSPShipmentBuilder shipment1Builder = ShipmentUtils.LSPShipmentBuilder.newInstance(shipmentSouthId);
+		shipment1Builder.setCapacityDemand(capacityDemand);
+		shipment1Builder.setFromLinkId(DEPOT_SOUTH_LINK_ID);
+		shipment1Builder.setToLinkId(Id.createLinkId("i(9,0)"));
+		shipment1Builder.setEndTimeWindow(TimeWindow.newInstance(0, (24 * 3600)));
+		shipment1Builder.setStartTimeWindow(TimeWindow.newInstance(0, (24)));
+		shipment1Builder.setDeliveryServiceTime(capacityDemand * 60);
+		shipmentList.add(shipment1Builder.build());
+
+		Id<LSPShipment> shipmentNorthId = Id.create("shipmentNorth", LSPShipment.class);
+		ShipmentUtils.LSPShipmentBuilder shipment2Builder = ShipmentUtils.LSPShipmentBuilder.newInstance(shipmentNorthId);
+		shipment2Builder.setCapacityDemand(capacityDemand);
+		shipment2Builder.setFromLinkId(DEPOT_NORTH_LINK_ID);
+		shipment2Builder.setToLinkId(Id.createLinkId("i(9,8)"));
+		shipment2Builder.setEndTimeWindow(TimeWindow.newInstance(0, (24 * 3600)));
+		shipment2Builder.setStartTimeWindow(TimeWindow.newInstance(0, (24)));
+		shipment2Builder.setDeliveryServiceTime(capacityDemand * 60);
+		shipmentList.add(shipment2Builder.build());
+
+		return shipmentList;
+	}
+
+	private static List<LSPResource> createResourcesListFromLSPPlans(List<LSPPlan> lspPlans) {
+		log.info("Collecting all LSPResources from the LSPPlans");
+		List<LSPResource> resourceList = new ArrayList<>();
+		for (LSPPlan lspPlan : lspPlans) {
+			for (LogisticChain solution : lspPlan.getLogisticChains()) {
+				for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
+					resourceList.add(solutionElement.getResource());
+				}
+			}
+		}
+		return resourceList;
+	}
+
+}
diff --git a/src/main/java/example/lsp/initialPlans/ExampleTwoEchelonGrid.java b/src/main/java/example/lsp/initialPlans/ExampleTwoEchelonGrid.java
@@ -388,7 +388,7 @@ private static List<LSPResource> createResourcesListFromLSPPlans(List<LSPPlan> l
 		log.info("Collecting all LSPResources from the LSPPlans");
 		List<LSPResource> resourcesList = new ArrayList<>();            //TODO: Mache daraus ein Set, damit jede Resource nur einmal drin ist? kmt Feb22
 		for (LSPPlan lspPlan : lspPlans) {
-			for (LogisticChain solution : lspPlan.getLogisticChain()) {
+			for (LogisticChain solution : lspPlan.getLogisticChains()) {
 				for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
 					resourcesList.add(solutionElement.getResource());
 				}

diff --git a/src/main/java/example/lsp/initialPlans/ExampleTwoEchelonGrid_NR.java b/src/main/java/example/lsp/initialPlans/ExampleTwoEchelonGrid_NR.java
@@ -392,7 +392,7 @@ private static List<LSPResource> createResourcesListFromLSPPlans(List<LSPPlan> l
 		log.info("Collecting all LSPResources from the LSPPlans");
 		List<LSPResource> resourcesList = new ArrayList<>();            //TODO: Mache daraus ein Set, damit jede Resource nur einmal drin ist? kmt Feb22
 		for (LSPPlan lspPlan : lspPlans) {
-			for (LogisticChain solution : lspPlan.getLogisticChain()) {
+			for (LogisticChain solution : lspPlan.getLogisticChains()) {
 				for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
 					resourcesList.add(solutionElement.getResource());
 				}

diff --git a/src/main/java/example/lsp/initialPlans/MyLSPScorer.java b/src/main/java/example/lsp/initialPlans/MyLSPScorer.java
@@ -30,7 +30,7 @@ public double getScoreForCurrentPlan() {
 
 	private void scoreLspCarriers() {
 		var lspPlan = lsp.getSelectedPlan();
-		for (LogisticChain solution : lspPlan.getLogisticChain()) {
+		for (LogisticChain solution : lspPlan.getLogisticChains()) {
 			for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
 				if (solutionElement.getResource() instanceof LSPCarrierResource carrierResource) {
 					var carriersScore = carrierResource.getCarrier().getSelectedPlan().getScore();
@@ -51,7 +51,7 @@ private void scoreLspCarriers() {
 	 */
 	private void scoreHub() {
 		var lspPlan = lsp.getSelectedPlan();
-		for (LogisticChain solution : lspPlan.getLogisticChain()) {
+		for (LogisticChain solution : lspPlan.getLogisticChains()) {
 			for (LogisticChainElement solutionElement : solution.getLogisticChainElements()) {
 				if (solutionElement.getResource() instanceof TransshipmentHub hub){
 					score = score - LSPUtils.getFixedCost(hub);

diff --git a/src/main/java/example/lsp/lspReplanning/ExampleLSPReplanning.java b/src/main/java/example/lsp/lspReplanning/ExampleLSPReplanning.java
@@ -220,11 +220,11 @@ public static void main(String[] args) {
 		controler.run();
 
 		System.out.println("Shipments delivered today:");
-		for (LSPShipment shipment : lsp.getSelectedPlan().getLogisticChain().iterator().next().getShipments()) {
+		for (LSPShipment shipment : lsp.getSelectedPlan().getLogisticChains().iterator().next().getShipments()) {
 			System.out.println(shipment.getId());
 		}
 
-		lsp.getShipments().removeAll(lsp.getSelectedPlan().getLogisticChain().iterator().next().getShipments());
+		lsp.getShipments().removeAll(lsp.getSelectedPlan().getLogisticChains().iterator().next().getShipments());
 
 		System.out.println("Shipments delivered tomorrow:");
 		for (LSPShipment shipment : lsp.getShipments()) {

diff --git a/src/main/java/example/lsp/lspReplanning/MaybeTodayAssigner.java b/src/main/java/example/lsp/lspReplanning/MaybeTodayAssigner.java
@@ -40,8 +40,8 @@ public MaybeTodayAssigner() {
 	public void assignToLogisticChain(LSPShipment shipment) {
 		boolean assignToday = random.nextBoolean();
 		if (assignToday) {
-			Gbl.assertIf(lsp.getSelectedPlan().getLogisticChain().size() == 1);
-			lsp.getSelectedPlan().getLogisticChain().iterator().next().assignShipment(shipment);
+			Gbl.assertIf(lsp.getSelectedPlan().getLogisticChains().size() == 1);
+			lsp.getSelectedPlan().getLogisticChains().iterator().next().assignShipment(shipment);
 		}
 	}