org.optaplanner.examples.vehiclerouting.domain.location

Class RoadLocation

java.lang.Object

org.optaplanner.examples.common.domain.AbstractPersistable

org.optaplanner.examples.vehiclerouting.domain.location.Location

org.optaplanner.examples.vehiclerouting.domain.location.RoadLocation

All Implemented Interfaces:

Serializable

public class RoadLocation
extends Location

The cost between 2 locations was precalculated on a real road network route. The cost itself might be the distance in km, the travel time, the fuel usage or a weighted function of any of those. Used with DistanceType.ROAD_DISTANCE.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<RoadLocation,Double>	travelDistanceMap

Fields inherited from class org.optaplanner.examples.vehiclerouting.domain.location.Location

latitude, longitude, name

Fields inherited from class org.optaplanner.examples.common.domain.AbstractPersistable

id

Constructor Summary

Constructors

Constructor and Description
RoadLocation()
RoadLocation(long id, double latitude, double longitude)

Method Summary

Modifier and Type	Method and Description
long	getDistanceTo(Location location) The distance's unit of measurement depends on the VehicleRoutingSolution's DistanceType.
Map<RoadLocation,Double>	getTravelDistanceMap()
void	setTravelDistanceMap(Map<RoadLocation,Double> travelDistanceMap)

Methods inherited from class org.optaplanner.examples.vehiclerouting.domain.location.Location

getAirDistanceDoubleTo, getAngle, getLatitude, getLongitude, getName, setLatitude, setLongitude, setName, toString

Methods inherited from class org.optaplanner.examples.common.domain.AbstractPersistable

getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

travelDistanceMap

protected Map<RoadLocation,Double> travelDistanceMap

Constructor Detail

RoadLocation

public RoadLocation()

RoadLocation

public RoadLocation(long id,
                    double latitude,
                    double longitude)

Method Detail

getTravelDistanceMap

public Map<RoadLocation,Double> getTravelDistanceMap()

setTravelDistanceMap

public void setTravelDistanceMap(Map<RoadLocation,Double> travelDistanceMap)

getDistanceTo

public long getDistanceTo(Location location)

Description copied from class: Location

The distance's unit of measurement depends on the VehicleRoutingSolution's DistanceType. It can be in miles or km, but for most cases it's in the TSPLIB's unit of measurement.

Specified by:

getDistanceTo in class Location

Parameters:

location - never null

Returns:

a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors