Cloud Optimization v1 API - Class Vehicle.Types.LoadLimit (2.3.0)

public sealed class Vehicle.Types.LoadLimit : IMessage<Vehicle.Types.LoadLimit>, IEquatable<Vehicle.Types.LoadLimit>, IDeepCloneable<Vehicle.Types.LoadLimit>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Optimization v1 API class Vehicle.Types.LoadLimit.

Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See [load_limits][google.cloud.optimization.v1.Vehicle.load_limits].

Inheritance

object > Vehicle.Types.LoadLimit

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

LoadLimit()

public LoadLimit()

LoadLimit(LoadLimit)

public LoadLimit(Vehicle.Types.LoadLimit other)
Parameter
NameDescription
otherVehicleTypesLoadLimit

Properties

CostPerUnitAboveSoftMax

public double CostPerUnitAboveSoftMax { get; set; }

If the load ever exceeds [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load] along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load])

  • [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs add up and must be in the same unit as [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost].
Property Value
TypeDescription
double

EndLoadInterval

public Vehicle.Types.LoadLimit.Types.Interval EndLoadInterval { get; set; }

The acceptable load interval of the vehicle at the end of the route.

Property Value
TypeDescription
VehicleTypesLoadLimitTypesInterval

HasMaxLoad

public bool HasMaxLoad { get; }

Gets whether the "max_load" field is set

Property Value
TypeDescription
bool

MaxLoad

public long MaxLoad { get; set; }

The maximum acceptable amount of load.

Property Value
TypeDescription
long

SoftMaxLoad

public long SoftMaxLoad { get; set; }

A soft limit of the load. See [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max].

Property Value
TypeDescription
long

StartLoadInterval

public Vehicle.Types.LoadLimit.Types.Interval StartLoadInterval { get; set; }

The acceptable load interval of the vehicle at the start of the route.

Property Value
TypeDescription
VehicleTypesLoadLimitTypesInterval