comments and javadoc

matsim-org · Dec 20, 2024 · cbe5a12 · cbe5a12
1 parent 10071db
commit cbe5a12
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 13 deletions.
diff --git a/contribs/freight/src/main/java/org/matsim/freight/carriers/CarrierService.java b/contribs/freight/src/main/java/org/matsim/freight/carriers/CarrierService.java
@@ -33,6 +33,9 @@ public static class Builder {
 		private final Id<CarrierService> id;
 		private int demand = 0;
 
+		//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+		//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+		//kturner dec'24
 		private final Id<Link> serviceLinkId;
 		private TimeWindow serviceStartsTimeWindow = TimeWindow.newInstance(0.0, Integer.MAX_VALUE);
 		private double serviceDuration = 0.0;
@@ -59,7 +62,7 @@ public CarrierService build(){
 		 * Note that the time-window restricts the start-time of the service (i.e. serviceActivity). If one works with hard time-windows (which means that
 		 * time-windows must be met) than the service is allowed to start between startTimeWindow.getStart() and startTimeWindow.getEnd().
 		 *
-		 * @param startTimeWindow 	time-window for the beginning of the service acti
+		 * @param startTimeWindow 	time-window for the beginning of the service activity
 		 * @return 					the builder
 		 */
 		public Builder setServiceStartTimeWindow(TimeWindow startTimeWindow){
@@ -79,9 +82,15 @@ public Builder setServiceDuration(double serviceDuration){
 			return this;
 		}
 
-
-
-
+		/**
+		* Sets the demand (size; capacity needed) of the service.
+		 * When not set, it is by default 0.
+		 * <p>
+		 * IMO we can put this into the Builder directly instead of a separate method? kturner dec'24
+		 *
+		 * @param value the demand (size; capacity needed) of the service
+		 * @return the builder
+		*/
 		public Builder setCapacityDemand(int value) {
 			this.demand = value;
 			return this;
@@ -93,6 +102,9 @@ public Builder setCapacityDemand(int value) {
 	private final Id<CarrierService> id;
 	private final int demand;
 
+	//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+	//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+	//kturner dec'24
 	private final Id<Link> serviceLinkId;
 	private final TimeWindow serviceStartsTimeWindow;
 	private final double serviceDuration;
@@ -127,7 +139,7 @@ public TimeWindow getServiceStartTimeWindow(){
 	/**
 	 * @deprecated please inline and use {@link #getDemand()} instead
 	 */
-	@Deprecated(since = "dez 2024")
+	@Deprecated(since = "dec'24")
 	public int getCapacityDemand() {
 		return getDemand();
 	}

diff --git a/contribs/freight/src/main/java/org/matsim/freight/carriers/CarrierShipment.java b/contribs/freight/src/main/java/org/matsim/freight/carriers/CarrierShipment.java
@@ -48,10 +48,16 @@ public static class Builder {
 		private final Id<CarrierShipment> id;
 		private final int demand;
 
+		//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+		//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+		//kturner dec'24
 		private final Id<Link> pickupLinkId;
 		private TimeWindow pickupStartsTimeWindow = TimeWindow.newInstance(0.0, Integer.MAX_VALUE);
 		private double pickupDuration = 0.0;
 
+		//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+		//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+		//kturner dec'24
 		private final Id<Link> deliveryLinkId;
 		private TimeWindow deliveryStartsTimeWindow = TimeWindow.newInstance(0.0, Integer.MAX_VALUE);
 		private double deliveryDuration = 0.0;
@@ -174,46 +180,49 @@ public CarrierShipment build(){
 		/**
 		 * @deprecated please inline and use {@link #setPickupStartsTimeWindow(TimeWindow)} instead
 		 */
-		@Deprecated(since = "dez 2024")
+		@Deprecated(since = "dec'24")
 		public Builder setPickupTimeWindow(TimeWindow pickupTW){
 			return setPickupStartsTimeWindow(pickupTW);
 		}
 
 		/**
 		 * @deprecated please inline and use {@link #setPickupDuration(double)} instead
 		 */
-		@Deprecated(since = "dez 2024")
+		@Deprecated(since = "dec'24")
 		public Builder setPickupServiceTime(double pickupServiceTime){
 			return setPickupDuration(pickupServiceTime);
 		}
 
 		/**
 		 * @deprecated please inline and use {@link #setDeliveryStartsTimeWindow(TimeWindow)} instead
 		 */
-		@Deprecated(since = "dez 2024")
+		@Deprecated(since = "dec'24")
 		public Builder setDeliveryTimeWindow(TimeWindow deliveryTW){
 			return setDeliveryStartsTimeWindow(deliveryTW);
 		}
 
 		/**
 		 * @deprecated please inline and use {@link #setDeliveryDuration(double)} instead
 		 */
-		@Deprecated(since = "dez 2024")
+		@Deprecated(since = "dec'24")
 		public Builder setDeliveryServiceTime(double deliveryServiceTime){
 			return setDeliveryDuration(deliveryServiceTime);
 		}
-
-
-
 	}
 
 	private final Id<CarrierShipment> id;
 	private final int demand;
 
+	//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+	//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+	//kturner dec'24
 	private final Id<Link> pickupLinkId;
 	private final TimeWindow pickupStartsTimeWindow;
 	private double pickupDuration;
 
+	//IMO we could build a general class (CarrierActivity ???), containing the location, StartTimeWindow and Duration.
+	//This could be used for both, CarrierService and CarrierShipment (Pickup and Delivery).
+	//kturner dec'24
 	private final Id<Link> deliveryLinkId;
 	private final TimeWindow deliveryStartsTimeWindow;
 	private double deliveryDuration;
@@ -264,7 +273,7 @@ public Id<Link> getTo() {
 	/**
 	 * @deprecated please inline and use {@link #getDemand()} instead
 	 */
-	@Deprecated(since = "dez 2024")
+	@Deprecated(since = "dec'24")
 	public int getSize() {
 		return getDemand();
 	}