trans/graphhopper-jsprit
1
0
Fork 0
mirror of https://github.com/graphhopper/jsprit.git synced 2020-01-24 07:45:05 +01:00
Code Issues Releases Wiki Activity

add javadoc (feature #127)

Browse source
This commit is contained in:
oblonski 2014-09-04 18:48:52 +02:00
parent d80f6bcd6d
commit b4e5ce888c
1 changed files with 43 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

43
jsprit-core/src/main/java/jsprit/core/problem/misc/JobInsertionContext.java
View file

@ -31,6 +31,9 @@ import java.util.List;
*/
public class JobInsertionContext {
/**
* Provides insertion context information about a particular activity.
*/
public static class ActivityContext {
private double arrivalTime;
@ -39,26 +42,66 @@ public class JobInsertionContext {
private int insertionIndex;
/**
* Returns arrival time at associated activity.
*
* @return arrival time
*/
public double getArrivalTime() {
return arrivalTime;
}
/**
* Returns end time of associated activity.
*
* @return end time
*/
public double getEndTime() {
return endTime;
}
/**
* Returns the insertion index of the associated vehicle.
*
* <p>The associated activity is not inserted yet. The actual insertion position is still to be evaluated.
* Thus this insertion index is related to the potential insertion index which is the position before
* the activity at this index in the existing route.
*
* if insertionIndex == 0, the associated activity will be inserted between start of vehicle and the first
* activity in activity sequence.
*
* if insertionIndex == relatedRoute.getActivities().size(), the associated activity will be inserted between
* the last activity in the activity sequence and the end of vehicle.
*
* @return insertion index
*/
public int getInsertionIndex() {
return insertionIndex;
}
/**
* Sets arrivalTime of associated vehicle at activity.
*
* @param arrivalTime arrival time of associated vehicle at activity
*/
public void setArrivalTime(double arrivalTime) {
this.arrivalTime = arrivalTime;
}
/**
* Sets end time of associated activity.
*
* @param endTime end time
*/
public void setEndTime(double endTime) {
this.endTime = endTime;
}
/**
* Sets insertion index of associated activity.
*
* @param insertionIndex insertion index of associated activity
*/
public void setInsertionIndex(int insertionIndex) {
this.insertionIndex = insertionIndex;
}