Class: Google::Cloud::Optimization::V1::SkippedShipment::Reason

Inherits:

Object

• Object
• Google::Cloud::Optimization::V1::SkippedShipment::Reason

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, reason will have more than 1 element. A skipped shipment cannot have duplicate reasons, i.e. where all fields are the same except for example_vehicle_index. Example:

reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 1
  example_exceeded_capacity_type: "Apples"
}
reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 3
  example_exceeded_capacity_type: "Pears"
}
reasons {
  code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
  example_vehicle_index: 1
}

The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1).

Defined Under Namespace

Modules: Code

Instance Attribute Summary

• #code ⇒ ::Google::Cloud::Optimization::V1::SkippedShipment::Reason::Code

  Refer to the comments of Code.

• #example_exceeded_capacity_type ⇒ ::String

  If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

• #example_vehicle_index ⇒ ::Integer

  If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

Instance Attribute Details

#code ⇒ ::Google::Cloud::Optimization::V1::SkippedShipment::Reason::Code

Returns Refer to the comments of Code.

Returns:

• (::Google::Cloud::Optimization::V1::SkippedShipment::Reason::Code) —

  Refer to the comments of Code.

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2388

class Reason
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Code identifying the reason type. The order here is meaningless. In
  # particular, it gives no indication of whether a given reason will
  # appear before another in the solution, if both apply.
  module Code
    # This should never be used. If we are unable to understand why a
    # shipment was skipped, we simply return an empty set of reasons.
    CODE_UNSPECIFIED = 0

    # There is no vehicle in the model making all shipments infeasible.
    NO_VEHICLE = 1

    # The demand of the shipment exceeds a vehicle's capacity for some
    # capacity types, one of which is `example_exceeded_capacity_type`.
    DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2

    # The minimum distance necessary to perform this shipment, i.e. from
    # the vehicle's `start_location` to the shipment's pickup and/or delivery
    # locations and to the vehicle's end location exceeds the vehicle's
    # `route_distance_limit`.
    #
    # Note that for this computation we use the geodesic distances.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3

    # The minimum time necessary to perform this shipment, including travel
    # time, wait time and service time exceeds the vehicle's
    # `route_duration_limit`.
    #
    # Note: travel time is computed in the best-case scenario, namely as
    # geodesic distance x 36 m/s (roughly 130 km/hour).
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4

    # Same as above but we only compare minimum travel time and the
    # vehicle's `travel_duration_limit`.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5

    # The vehicle cannot perform this shipment in the best-case scenario
    # (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
    # computation) if it starts at its earliest start time: the total time
    # would make the vehicle end after its latest end time.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6

    # The `allowed_vehicle_indices` field of the shipment is not empty and
    # this vehicle does not belong to it.
    VEHICLE_NOT_ALLOWED = 7
  end
end

#example_exceeded_capacity_type ⇒ ::String

Returns If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

Returns:

• (::String) —

  If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2388

class Reason
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Code identifying the reason type. The order here is meaningless. In
  # particular, it gives no indication of whether a given reason will
  # appear before another in the solution, if both apply.
  module Code
    # This should never be used. If we are unable to understand why a
    # shipment was skipped, we simply return an empty set of reasons.
    CODE_UNSPECIFIED = 0

    # There is no vehicle in the model making all shipments infeasible.
    NO_VEHICLE = 1

    # The demand of the shipment exceeds a vehicle's capacity for some
    # capacity types, one of which is `example_exceeded_capacity_type`.
    DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2

    # The minimum distance necessary to perform this shipment, i.e. from
    # the vehicle's `start_location` to the shipment's pickup and/or delivery
    # locations and to the vehicle's end location exceeds the vehicle's
    # `route_distance_limit`.
    #
    # Note that for this computation we use the geodesic distances.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3

    # The minimum time necessary to perform this shipment, including travel
    # time, wait time and service time exceeds the vehicle's
    # `route_duration_limit`.
    #
    # Note: travel time is computed in the best-case scenario, namely as
    # geodesic distance x 36 m/s (roughly 130 km/hour).
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4

    # Same as above but we only compare minimum travel time and the
    # vehicle's `travel_duration_limit`.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5

    # The vehicle cannot perform this shipment in the best-case scenario
    # (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
    # computation) if it starts at its earliest start time: the total time
    # would make the vehicle end after its latest end time.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6

    # The `allowed_vehicle_indices` field of the shipment is not empty and
    # this vehicle does not belong to it.
    VEHICLE_NOT_ALLOWED = 7
  end
end

#example_vehicle_index ⇒ ::Integer

Returns If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

Returns:

• (::Integer) —

  If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2388

class Reason
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Code identifying the reason type. The order here is meaningless. In
  # particular, it gives no indication of whether a given reason will
  # appear before another in the solution, if both apply.
  module Code
    # This should never be used. If we are unable to understand why a
    # shipment was skipped, we simply return an empty set of reasons.
    CODE_UNSPECIFIED = 0

    # There is no vehicle in the model making all shipments infeasible.
    NO_VEHICLE = 1

    # The demand of the shipment exceeds a vehicle's capacity for some
    # capacity types, one of which is `example_exceeded_capacity_type`.
    DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2

    # The minimum distance necessary to perform this shipment, i.e. from
    # the vehicle's `start_location` to the shipment's pickup and/or delivery
    # locations and to the vehicle's end location exceeds the vehicle's
    # `route_distance_limit`.
    #
    # Note that for this computation we use the geodesic distances.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3

    # The minimum time necessary to perform this shipment, including travel
    # time, wait time and service time exceeds the vehicle's
    # `route_duration_limit`.
    #
    # Note: travel time is computed in the best-case scenario, namely as
    # geodesic distance x 36 m/s (roughly 130 km/hour).
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4

    # Same as above but we only compare minimum travel time and the
    # vehicle's `travel_duration_limit`.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5

    # The vehicle cannot perform this shipment in the best-case scenario
    # (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
    # computation) if it starts at its earliest start time: the total time
    # would make the vehicle end after its latest end time.
    CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6

    # The `allowed_vehicle_indices` field of the shipment is not empty and
    # this vehicle does not belong to it.
    VEHICLE_NOT_ALLOWED = 7
  end
end