Class Vehicle

Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from start_location and ending at end_location for this vehicle. A route is a sequence of visits (see ShipmentRoute).

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

Constructors

Vehicle()

Declaration
public Vehicle()

Vehicle(Vehicle)

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

Properties

BreakRule

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

Declaration
public BreakRule BreakRule { get; set; }
Property Value
Type Description
BreakRule

CostPerHour

Vehicle costs: all costs add up and must be in the same unit as [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost].

Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using cost_per_hour instead of just cost_per_traveled_hour may result in additional latency.

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

CostPerKilometer

Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions] and does not apply to any distance implicitly traveled from the arrival_location to the departure_location of a single VisitRequest.

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

CostPerTraveledHour

Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (i.e., that reported in [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions]), and excludes waiting time and visit time.

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

DisplayName

The user-defined display name of the vehicle. 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

EndLocation

Geographic location where the vehicle ends after it has completed its last VisitRequest. If not specified the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest. If the shipment model has duration and distance matrices, end_location must not be specified.

Declaration
public LatLng EndLocation { get; set; }
Property Value
Type Description
LatLng

EndTags

Specifies tags attached to the end of the vehicle's route.

Empty or duplicate strings are not allowed.

Declaration
public RepeatedField<string> EndTags { get; }
Property Value
Type Description
RepeatedField<string>

EndTimeWindows

Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see [ShipmentModel.global_*][google.maps.routeoptimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits.

Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

Declaration
public RepeatedField<TimeWindow> EndTimeWindows { get; }
Property Value
Type Description
RepeatedField<TimeWindow>

EndWaypoint

Waypoint representing a geographic location where the vehicle ends after it has completed its last VisitRequest. If neither end_waypoint nor end_location is specified, the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest. If the shipment model has duration and distance matrices, end_waypoint must not be specified.

Declaration
public Waypoint EndWaypoint { get; set; }
Property Value
Type Description
Waypoint

ExtraVisitDurationForVisitType

Specifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.maps.routeoptimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified visit_types. This extra visit duration adds cost if cost_per_hour is specified. Keys (i.e. visit_types) cannot be empty strings.

If a visit request has multiple types, a duration will be added for each type in the map.

Declaration
public MapField<string, Duration> ExtraVisitDurationForVisitType { get; }
Property Value
Type Description
MapField<string, Duration>

FixedCost

Fixed cost applied if this vehicle is used to handle a shipment.

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

HasTravelDurationMultiple

Gets whether the "travel_duration_multiple" field is set

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

Ignore

If true, used_if_route_is_empty must be false, and this vehicle will remain unused.

If a shipment is performed by an ignored vehicle in injected_first_solution_routes, it is skipped in the first solution but is free to be performed in the response.

If a shipment is performed by an ignored vehicle in injected_solution_constraint and any related pickup/delivery is constrained to remain on the vehicle (i.e., not relaxed to level RELAX_ALL_AFTER_THRESHOLD), it is skipped in the response. If a shipment has a non-empty allowed_vehicle_indices field and all of the allowed vehicles are ignored, it is skipped in the response.

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

Label

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding [ShipmentRoute][google.maps.routeoptimization.v1.ShipmentRoute].

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

LoadLimits

Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.

Declaration
public MapField<string, Vehicle.Types.LoadLimit> LoadLimits { get; }
Property Value
Type Description
MapField<string, Vehicle.Types.LoadLimit>

RouteDistanceLimit

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse, the route distance is the sum of all its [transitions.travel_distance_meters][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_distance_meters].

Declaration
public DistanceLimit RouteDistanceLimit { get; set; }
Property Value
Type Description
DistanceLimit

RouteDurationLimit

Limit applied to the total duration of the vehicle's route. In a given OptimizeToursResponse, the route duration of a vehicle is the difference between its vehicle_end_time and vehicle_start_time.

Declaration
public Vehicle.Types.DurationLimit RouteDurationLimit { get; set; }
Property Value
Type Description
Vehicle.Types.DurationLimit

RouteModifiers

A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.

Declaration
public RouteModifiers RouteModifiers { get; set; }
Property Value
Type Description
RouteModifiers

StartLocation

Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_location must not be specified.

Declaration
public LatLng StartLocation { get; set; }
Property Value
Type Description
LatLng

StartTags

Specifies tags attached to the start of the vehicle's route.

Empty or duplicate strings are not allowed.

Declaration
public RepeatedField<string> StartTags { get; }
Property Value
Type Description
RepeatedField<string>

StartTimeWindows

Time windows during which the vehicle may depart its start location. They must be within the global time limits (see [ShipmentModel.global_*][google.maps.routeoptimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits.

Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

Declaration
public RepeatedField<TimeWindow> StartTimeWindows { get; }
Property Value
Type Description
RepeatedField<TimeWindow>

StartWaypoint

Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither start_waypoint nor start_location is specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_waypoint must not be specified.

Declaration
public Waypoint StartWaypoint { get; set; }
Property Value
Type Description
Waypoint

TravelDurationLimit

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse, the route travel duration is the sum of all its [transitions.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration].

Declaration
public Vehicle.Types.DurationLimit TravelDurationLimit { get; set; }
Property Value
Type Description
Vehicle.Types.DurationLimit

TravelDurationMultiple

Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if cost_per_hour or cost_per_traveled_hour are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0.

WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision.

See also extra_visit_duration_for_visit_type below.

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

TravelMode

The travel mode which affects the roads usable by the vehicle and its speed. See also travel_duration_multiple.

Declaration
public Vehicle.Types.TravelMode TravelMode { get; set; }
Property Value
Type Description
Vehicle.Types.TravelMode

UnloadingPolicy

Unloading policy enforced on the vehicle.

Declaration
public Vehicle.Types.UnloadingPolicy UnloadingPolicy { get; set; }
Property Value
Type Description
Vehicle.Types.UnloadingPolicy

UsedIfRouteIsEmpty

This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case.

If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account.

Otherwise, it doesn't travel from its start to its end location, and no break_rule or delay (from TransitionAttributes) are scheduled for this vehicle. In this case, the vehicle's ShipmentRoute doesn't contain any information except for the vehicle index and label.

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