Class: Google::Cloud::Optimization::V1::ShipmentRoute::Visit

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

A visit performed during a route. This visit corresponds to a pickup or a delivery of a Shipment.

Defined Under Namespace

Classes: LoadDemandsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#arrival_loads ⇒ ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use Transition.vehicle_loads instead. Vehicle loads upon arrival at the visit location, for each type specified in Vehicle.capacities, start_load_intervals, end_load_intervals or demands.

Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route.

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delay_before_start ⇒ ::Google::Cloud::Optimization::V1::ShipmentRoute::Delay

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Delay occurring before the visit starts.

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#demands ⇒ ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Use Visit.load_demands instead.

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#detour ⇒ ::Google::Protobuf::Duration

Returns Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to:

start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).

Otherwise, it is computed from the vehicle start_location and is equal to:

start_time - vehicle_start_time - travel duration from
the vehicle's `start_location` to the visit.
```.

Returns:

  • (::Google::Protobuf::Duration) —

    Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to:

    start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).

    Otherwise, it is computed from the vehicle start_location and is equal to:

    start_time - vehicle_start_time - travel duration from
the vehicle's `start_location` to the visit.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_pickup ⇒ ::Boolean

Returns If true the visit corresponds to a pickup of a Shipment. Otherwise, it corresponds to a delivery.

Returns:

  • (::Boolean) —

    If true the visit corresponds to a pickup of a Shipment. Otherwise, it corresponds to a delivery.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#load_demands ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Shipment::Load}

Returns Total visit load demand as the sum of the shipment and the visit request load_demands. The values are negative if the visit is a delivery. Demands are reported for the same types as the Transition.loads (see this field).

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipment_index ⇒ ::Integer

Returns Index of the shipments field in the source ShipmentModel.

Returns:

  • (::Integer) —

    Index of the shipments field in the source ShipmentModel.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shipment_label ⇒ ::String

Returns Copy of the corresponding Shipment.label, if specified in the Shipment.

Returns:

  • (::String) —

    Copy of the corresponding Shipment.label, if specified in the Shipment.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the ShipmentModel.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the ShipmentModel.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#visit_label ⇒ ::String

Returns Copy of the corresponding VisitRequest.label, if specified in the VisitRequest.

Returns:

  • (::String) —

    Copy of the corresponding VisitRequest.label, if specified in the VisitRequest.



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#visit_request_index ⇒ ::Integer

Returns Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup).

Returns:

  • (::Integer) —

    Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup).



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2145

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Optimization::V1::Shipment::Load]
  class LoadDemandsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end