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
Inherited Members
Namespace: Google.Maps.RouteOptimization.V1
Assembly: Google.Maps.RouteOptimization.V1.dll
Syntax
public sealed class DistanceLimit : IMessage<DistanceLimit>, IEquatable<DistanceLimit>, IDeepCloneable<DistanceLimit>, IBufferMessage, IMessage

Constructors

DistanceLimit()

Declaration
public DistanceLimit()

DistanceLimit(DistanceLimit)

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

Properties

CostPerKilometerAboveSoftMax

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.

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

CostPerKilometerBelowSoftMax

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.

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

HasCostPerKilometerAboveSoftMax

Gets whether the "cost_per_kilometer_above_soft_max" field is set

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

HasCostPerKilometerBelowSoftMax

Gets whether the "cost_per_kilometer_below_soft_max" field is set

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

HasMaxMeters

Gets whether the "max_meters" field is set

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

HasSoftMaxMeters

Gets whether the "soft_max_meters" field is set

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

MaxMeters

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

Declaration
public long MaxMeters { get; set; }
Property Value
Type Description
long

SoftMaxMeters

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.

Declaration
public long SoftMaxMeters { get; set; }
Property Value
Type Description
long