JOpt.SDK
Interface IOptimizationResult

All Known Implementing Classes:
OptimizationResult

public interface IOptimizationResult

IOptimizationResult provides access to the Optimization result. The Optimization result consists of several optimization metrics like total distance, total cost, etc. as well as a list of routes and resources that are assigend to these routes.


Method Summary
 void addRoute(IRoute route)
           
 void addViolation(IViolation routeId)
           
 java.util.GregorianCalendar getEnd()
           
 IRoute[] getRoutes()
           
 java.util.GregorianCalendar getStart()
           
 double getTimeBreak()
           
 double getTimeIdle()
           
 double getTimeStop()
           
 double getTimeTotal()
           
 double getTimeTrip()
           
 double getTotalCost()
           
 double getTotalDistance()
           
 IViolation[] getViolations()
           
 void setEnd(java.util.GregorianCalendar routeEnd)
           
 void setStart(java.util.GregorianCalendar routeStart)
           
 void setTimeBreak(double timeBreak)
           
 void setTimeIdle(double timeIdle)
           
 void setTimeStop(double timeStop)
           
 void setTimeTotal(double timeTotal)
           
 void setTimeTrip(double timeTrip)
           
 void setTotalCost(double totalCost)
           
 void setTotalDistance(double totalDistance)
           
 

Method Detail

setTotalDistance

public void setTotalDistance(double totalDistance)
Parameters:
totalDistance - the total distance that makes up the sum of all routes within this optimization run.

getTotalDistance

public double getTotalDistance()
Returns:
the total distance that makes up the sum of all routes within this optimization run.

setTotalCost

public void setTotalCost(double totalCost)

getTotalCost

public double getTotalCost()
Returns:
the total cost that makes up the sum of all routes within this optimization run.

setStart

public void setStart(java.util.GregorianCalendar routeStart)
Parameters:
routeStart - the start of the first route

getStart

public java.util.GregorianCalendar getStart()
Returns:
the start of the first route

setEnd

public void setEnd(java.util.GregorianCalendar routeEnd)
Parameters:
routeEnd - the end of the last route

getEnd

public java.util.GregorianCalendar getEnd()
Returns:
the end of the last route

setTimeTotal

public void setTimeTotal(double timeTotal)
Parameters:
timeTotal - the total time consumed that makes up the sum of all routes within this optimization run.

getTimeTotal

public double getTimeTotal()
Returns:
the total time consumed that makes up the sum of all routes within this optimization run.

setTimeStop

public void setTimeStop(double timeStop)
Parameters:
timeStop - the total time where the resources stay at the stop. This makes up the sum of all stops within this optimization run.

getTimeStop

public double getTimeStop()
Returns:
the total time where the resources stay at the stop. This makes up the sum of all stops within this optimization run.

setTimeTrip

public void setTimeTrip(double timeTrip)
Parameters:
timeTrip - the total time where the resources are on the road. This makes up the sum of all road times within this optimization run.

getTimeTrip

public double getTimeTrip()
Returns:
the total time where the resources are on the road. This makes up the sum of all road times within this optimization run.

setTimeBreak

public void setTimeBreak(double timeBreak)

getTimeBreak

public double getTimeBreak()
Returns:
the total time where the resources are having a break. This makes up the sum of all break times within this optimization run.

setTimeIdle

public void setTimeIdle(double timeIdle)
Parameters:
timeIdle - the total time where the resources are waiting for a node to open. This makes up the sum of all waiting times within this optimization run.

getTimeIdle

public double getTimeIdle()
Returns:
the total time where the resources are waiting for a node to open. This makes up the sum of all waiting times within this optimization run.

getRoutes

public IRoute[] getRoutes()
Returns:
the routes that have been created within this optimization run

addRoute

public void addRoute(IRoute route)
Parameters:
route - a routes that has been created within this optimization run

addViolation

public void addViolation(IViolation routeId)

getViolations

public IViolation[] getViolations()
Returns:
the routes with at least one constaint violation