org.optaweb.vehiclerouting.service.route

Class RouteChangedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.optaweb.vehiclerouting.service.route.RouteChangedEvent

All Implemented Interfaces:

Serializable

public class RouteChangedEvent
extends org.springframework.context.ApplicationEvent

Event published when the routing plan has been updated either by discovering a better route or by a change in the problem specification (vehicles, visits).

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RouteChangedEvent(Object source, Distance distance, List<Long> vehicleIds, Long depotId, List<Long> visitIds, Collection<ShallowRoute> routes) Create a new ApplicationEvent.

Method Summary

Modifier and Type	Method and Description
Optional<Long>	depotId() The depot ID.
Distance	distance() Routing plan distance.
Collection<ShallowRoute>	routes() Routes of all vehicles.
List<Long>	vehicleIds() IDs of all vehicles.
List<Long>	visitIds()

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteChangedEvent

public RouteChangedEvent(Object source,
                         Distance distance,
                         List<Long> vehicleIds,
                         Long depotId,
                         List<Long> visitIds,
                         Collection<ShallowRoute> routes)

Create a new ApplicationEvent.

Parameters:

source - the object on which the event initially occurred (never null)

distance - total distance of all vehicle routes

vehicleIds - vehicle IDs

depotId - depot ID (may be null if there are no locations)

visitIds - IDs of visits

routes - vehicle routes

Method Detail

vehicleIds

public List<Long> vehicleIds()

IDs of all vehicles.

Returns:

vehicle IDs

routes

public Collection<ShallowRoute> routes()

Routes of all vehicles.

Returns:

vehicle routes

distance

public Distance distance()

Routing plan distance.

Returns:

distance (never null)

depotId

public Optional<Long> depotId()

The depot ID.

Returns:

depot ID

visitIds

public List<Long> visitIds()