Cloud Optimization v1 API - Class DistanceLimit (2.6.0)

public sealed class DistanceLimit : IMessage<DistanceLimit>, IEquatable<DistanceLimit>, IDeepCloneable<DistanceLimit>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Optimization v1 API class DistanceLimit.

A limit defining a maximum distance which can be traveled. It can be either hard or soft.

If a soft limit is defined, both soft_max_meters and cost_per_kilometer_above_soft_max must be defined and be nonnegative.

Inheritance

object > DistanceLimit

Implements

IMessage DistanceLimit, IEquatable DistanceLimit, IDeepCloneable DistanceLimit, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

DistanceLimit()

public DistanceLimit()

DistanceLimit(DistanceLimit)

public DistanceLimit(DistanceLimit other)

Parameter
Name	Description
`other`	`DistanceLimit`

Properties

CostPerKilometerAboveSoftMax

public double CostPerKilometerAboveSoftMax { get; set; }

Cost per kilometer incurred if distance is above soft_max_meters limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following:

  (distance_meters - soft_max_meters) / 1000.0 *
  cost_per_kilometer_above_soft_max.

The cost must be nonnegative.

Property Value
Type	Description
`double`

CostPerKilometerBelowSoftMax

public double CostPerKilometerBelowSoftMax { get; set; }

Cost per kilometer incurred, increasing up to soft_max_meters, with formula:

  min(distance_meters, soft_max_meters) / 1000.0 *
  cost_per_kilometer_below_soft_max.

This cost is not supported in route_distance_limit.

Property Value
Type	Description
`double`

HasCostPerKilometerAboveSoftMax

public bool HasCostPerKilometerAboveSoftMax { get; }

Gets whether the "cost_per_kilometer_above_soft_max" field is set

Property Value
Type	Description
`bool`

HasCostPerKilometerBelowSoftMax

public bool HasCostPerKilometerBelowSoftMax { get; }

Gets whether the "cost_per_kilometer_below_soft_max" field is set

Property Value
Type	Description
`bool`

HasMaxMeters

public bool HasMaxMeters { get; }

Gets whether the "max_meters" field is set

Property Value
Type	Description
`bool`

HasSoftMaxMeters

public bool HasSoftMaxMeters { get; }

Gets whether the "soft_max_meters" field is set

Property Value
Type	Description
`bool`

MaxMeters

public long MaxMeters { get; set; }

A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.

Property Value
Type	Description
`long`

SoftMaxMeters

public long SoftMaxMeters { get; set; }

A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit.

If defined soft_max_meters must be less than max_meters and must be nonnegative.

Property Value
Type	Description
`long`