Google Cloud Optimization V1 Client - Class Visit (1.0.0)

Reference documentation and code samples for the Google Cloud Optimization V1 Client class Visit.

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

Generated from protobuf message google.cloud.optimization.v1.ShipmentRoute.Visit

Namespace

Google \ Cloud \ Optimization \ V1 \ ShipmentRoute

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ shipment_index int

Index of the shipments field in the source ShipmentModel.
↳ is_pickup bool

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

Index of VisitRequest in either the pickup or delivery field of the Shipment (see is_pickup).
↳ start_time 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.
↳ load_demands array|Google\Protobuf\Internal\MapField

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).
↳ detour 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.
↳ shipment_label string

Copy of the corresponding Shipment.label, if specified in the Shipment.
↳ visit_label string

Copy of the corresponding VisitRequest.label, if specified in the VisitRequest.
↳ arrival_loads array<Google\Cloud\Optimization\V1\CapacityQuantity>

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.
↳ delay_before_start Google\Cloud\Optimization\V1\ShipmentRoute\Delay

Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Delay occurring before the visit starts.
↳ demands array<Google\Cloud\Optimization\V1\CapacityQuantity>

Deprecated: Use Visit.load_demands instead.

getShipmentIndex

Index of the shipments field in the source ShipmentModel.

Returns
Type Description
int

setShipmentIndex

Index of the shipments field in the source ShipmentModel.

Parameter
Name Description
var int
Returns
Type Description
$this

getIsPickup

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

Returns
Type Description
bool

setIsPickup

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getVisitRequestIndex

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

Returns
Type Description
int

setVisitRequestIndex

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

Parameter
Name Description
var int
Returns
Type Description
$this

getStartTime

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
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLoadDemands

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
Type Description
Google\Protobuf\Internal\MapField

setLoadDemands

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).

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDetour

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
Type Description
Google\Protobuf\Duration|null

hasDetour

clearDetour

setDetour

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.
Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getShipmentLabel

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

Returns
Type Description
string

setShipmentLabel

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

Parameter
Name Description
var string
Returns
Type Description
$this

getVisitLabel

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

Returns
Type Description
string

setVisitLabel

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

Parameter
Name Description
var string
Returns
Type Description
$this

getArrivalLoads

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
Type Description
Google\Protobuf\Internal\RepeatedField

setArrivalLoads

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.

Parameter
Name Description
var array<Google\Cloud\Optimization\V1\CapacityQuantity>
Returns
Type Description
$this

getDelayBeforeStart

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

Returns
Type Description
Google\Cloud\Optimization\V1\ShipmentRoute\Delay|null

hasDelayBeforeStart

clearDelayBeforeStart

setDelayBeforeStart

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

Parameter
Name Description
var Google\Cloud\Optimization\V1\ShipmentRoute\Delay
Returns
Type Description
$this

getDemands

Deprecated: Use Visit.load_demands instead.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDemands

Deprecated: Use Visit.load_demands instead.

Parameter
Name Description
var array<Google\Cloud\Optimization\V1\CapacityQuantity>
Returns
Type Description
$this