Class Shipment

The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).

Inheritance
object
Shipment
Implements
Inherited Members
Namespace: Google.Maps.RouteOptimization.V1
Assembly: Google.Maps.RouteOptimization.V1.dll
Syntax
public sealed class Shipment : IMessage<Shipment>, IEquatable<Shipment>, IDeepCloneable<Shipment>, IBufferMessage, IMessage

Constructors

Shipment()

Declaration
public Shipment()

Shipment(Shipment)

Declaration
public Shipment(Shipment other)
Parameters
Type Name Description
Shipment other

Properties

AllowedVehicleIndices

The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the ShipmentModel's vehicles list.

Declaration
public RepeatedField<int> AllowedVehicleIndices { get; }
Property Value
Type Description
RepeatedField<int>

CostsPerVehicle

Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER:

  • the same number of elements as costs_per_vehicle_indices. costs_per_vehicle[i] corresponds to vehicle costs_per_vehicle_indices[i] of the model.
  • the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model.

These costs must be in the same unit as penalty_cost and must not be negative. Leave this field empty, if there are no such costs.

Declaration
public RepeatedField<double> CostsPerVehicle { get; }
Property Value
Type Description
RepeatedField<double>

CostsPerVehicleIndices

Indices of the vehicles to which costs_per_vehicle applies. If non-empty, it must have the same number of elements as costs_per_vehicle. A vehicle index may not be specified more than once. If a vehicle is excluded from costs_per_vehicle_indices, its cost is zero.

Declaration
public RepeatedField<int> CostsPerVehicleIndices { get; }
Property Value
Type Description
RepeatedField<int>

Deliveries

Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups.

Declaration
public RepeatedField<Shipment.Types.VisitRequest> Deliveries { get; }
Property Value
Type Description
RepeatedField<Shipment.Types.VisitRequest>

DisplayName

The user-defined display name of the shipment. It can be up to 63 characters long and may use UTF-8 characters.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

HasPenaltyCost

Gets whether the "penalty_cost" field is set

Declaration
public bool HasPenaltyCost { get; }
Property Value
Type Description
bool

HasPickupToDeliveryRelativeDetourLimit

Gets whether the "pickup_to_delivery_relative_detour_limit" field is set

Declaration
public bool HasPickupToDeliveryRelativeDetourLimit { get; }
Property Value
Type Description
bool

Ignore

If true, skip this shipment, but don't apply a penalty_cost.

Ignoring a shipment results in a validation error when there are any shipment_type_requirements in the model.

Ignoring a shipment that is performed in injected_first_solution_routes or injected_solution_constraint is permitted; the solver removes the related pickup/delivery visits from the performing route. precedence_rules that reference ignored shipments will also be ignored.

Declaration
public bool Ignore { get; set; }
Property Value
Type Description
bool

Label

Specifies a label for this shipment. This label is reported in the response in the shipment_label of the corresponding [ShipmentRoute.Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit].

Declaration
public string Label { get; set; }
Property Value
Type Description
string

LoadDemands

Load demands of the shipment (for example weight, volume, number of pallets etc). The keys in the map should be identifiers describing the type of the corresponding load, ideally also including the units. For example: "weight_kg", "volume_gallons", "pallet_count", etc. If a given key does not appear in the map, the corresponding load is considered as null.

Declaration
public MapField<string, Shipment.Types.Load> LoadDemands { get; }
Property Value
Type Description
MapField<string, Shipment.Types.Load>

PenaltyCost

If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive.

IMPORTANT: If this penalty is not specified, it is considered infinite, i.e. the shipment must be completed.

Declaration
public double PenaltyCost { get; set; }
Property Value
Type Description
double

PickupToDeliveryAbsoluteDetourLimit

Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_absolute_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
t + pickup_to_delivery_absolute_detour_limit

If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles.

Declaration
public Duration PickupToDeliveryAbsoluteDetourLimit { get; set; }
Property Value
Type Description
Duration

PickupToDeliveryRelativeDetourLimit

Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery.

For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting pickup_to_delivery_relative_detour_limit enforces:

start_time(delivery) - start_time(pickup) <=
std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit))

If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles.

Declaration
public double PickupToDeliveryRelativeDetourLimit { get; set; }
Property Value
Type Description
double

PickupToDeliveryTimeLimit

Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications.

Declaration
public Duration PickupToDeliveryTimeLimit { get; set; }
Property Value
Type Description
Duration

Pickups

Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries.

Declaration
public RepeatedField<Shipment.Types.VisitRequest> Pickups { get; }
Property Value
Type Description
RepeatedField<Shipment.Types.VisitRequest>

ShipmentType

Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between shipment_types (see shipment_type_incompatibilities and shipment_type_requirements in ShipmentModel).

Differs from visit_types which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same shipment_type.

Declaration
public string ShipmentType { get; set; }
Property Value
Type Description
string