Package org.optaweb.vehiclerouting.plugin.planner.domain

Class PlanningVisit

java.lang.Object

org.optaweb.vehiclerouting.plugin.planner.domain.PlanningVisit

All Implemented Interfaces:

Standstill

public class PlanningVisit
extends Object
implements Standstill

Constructor Summary

Constructors

Constructor	Description
PlanningVisit()

Method Summary

Modifier and Type	Method	Description
long	distanceFromPreviousStandstill()	Distance from the previous standstill to this visit.
long	distanceToDepot()	Distance from this visit back to the depot.
int	getDemand()
long	getId()
PlanningLocation	getLocation()	The standstill's location.
PlanningVisit	getNextVisit()	The next visit after this standstill.
Standstill	getPreviousStandstill()
PlanningVehicle	getVehicle()
boolean	isLast()	Whether this visit is the last in a chain.
void	setDemand(int demand)
void	setId(long id)
void	setLocation(PlanningLocation location)
void	setNextVisit(PlanningVisit nextVisit)
void	setPreviousStandstill(Standstill previousStandstill)
void	setVehicle(PlanningVehicle vehicle)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PlanningVisit

PlanningVisit()

Method Detail

getId

public long getId()

setId

public void setId(long id)

getLocation

public PlanningLocation getLocation()

Description copied from interface: Standstill

The standstill's location.

Specified by:

getLocation in interface Standstill

Returns:

never null

setLocation

public void setLocation(PlanningLocation location)

getDemand

public int getDemand()

setDemand

public void setDemand(int demand)

getPreviousStandstill

public Standstill getPreviousStandstill()

setPreviousStandstill

public void setPreviousStandstill(Standstill previousStandstill)

getNextVisit

public PlanningVisit getNextVisit()

Description copied from interface: Standstill

The next visit after this standstill.

Specified by:

getNextVisit in interface Standstill

Returns:

sometimes null

setNextVisit

public void setNextVisit(PlanningVisit nextVisit)

Specified by:

setNextVisit in interface Standstill

getVehicle

public PlanningVehicle getVehicle()

setVehicle

public void setVehicle(PlanningVehicle vehicle)

distanceFromPreviousStandstill

public long distanceFromPreviousStandstill()

Distance from the previous standstill to this visit. This is used to calculate the travel cost of a chain beginning with a vehicle (at a depot) and ending with the last visit. The chain ends with a visit, not a depot so the cost of returning from the last visit back to the depot has to be added in a separate step using distanceToDepot().

Returns:

distance from previous standstill to this visit

distanceToDepot

public long distanceToDepot()

Distance from this visit back to the depot.

Returns:

distance from this visit back its vehicle's depot

isLast

public boolean isLast()

Whether this visit is the last in a chain.

Returns:

true, if this visit has no next visit

toString

public String toString()

Overrides:

toString in class Object