mirror of
https://github.com/graphhopper/jsprit.git
synced 2020-01-24 07:45:05 +01:00
696 lines
30 KiB
HTML
696 lines
30 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_51) on Wed Oct 09 15:10:19 CEST 2013 -->
|
|
<TITLE>
|
|
VehicleRoutingProblem.Builder
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2013-10-09">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="VehicleRoutingProblem.Builder";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VehicleRoutingProblem.Builder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../basics/VehicleRoutingProblem.html" title="class in basics"><B>PREV CLASS</B></A>
|
|
<A HREF="../basics/VehicleRoutingProblem.Constraint.html" title="enum in basics"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../index.html?basics/VehicleRoutingProblem.Builder.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="VehicleRoutingProblem.Builder.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
basics</FONT>
|
|
<BR>
|
|
Class VehicleRoutingProblem.Builder</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>basics.VehicleRoutingProblem.Builder</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>Enclosing class:</B><DD><A HREF="../basics/VehicleRoutingProblem.html" title="class in basics">VehicleRoutingProblem</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public static class <B>VehicleRoutingProblem.Builder</B><DT>extends java.lang.Object</DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Builder to build the routing-problem.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>stefan schroeder</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#VehicleRoutingProblem.Builder()">VehicleRoutingProblem.Builder</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addAllJobs(java.util.Collection)">addAllJobs</A></B>(java.util.Collection<<A HREF="../basics/Job.html" title="interface in basics">Job</A>> jobs)</CODE>
|
|
|
|
<BR>
|
|
Adds a collection of jobs.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addAllVehicles(java.util.Collection)">addAllVehicles</A></B>(java.util.Collection<<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A>> vehicles)</CODE>
|
|
|
|
<BR>
|
|
Adds a collection of vehicles.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addJob(basics.Job)">addJob</A></B>(<A HREF="../basics/Job.html" title="interface in basics">Job</A> job)</CODE>
|
|
|
|
<BR>
|
|
Adds a job which is either a service or a shipment.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addLocation(java.lang.String, util.Coordinate)">addLocation</A></B>(java.lang.String id,
|
|
<A HREF="../util/Coordinate.html" title="class in util">Coordinate</A> coord)</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addProblemConstraint(basics.VehicleRoutingProblem.Constraint)">addProblemConstraint</A></B>(<A HREF="../basics/VehicleRoutingProblem.Constraint.html" title="enum in basics">VehicleRoutingProblem.Constraint</A> constraint)</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addService(basics.Service)">addService</A></B>(<A HREF="../basics/Service.html" title="class in basics">Service</A> service)</CODE>
|
|
|
|
<BR>
|
|
Adds a service to jobList.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addVehicle(basics.route.Vehicle)">addVehicle</A></B>(<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A> vehicle)</CODE>
|
|
|
|
<BR>
|
|
Adds a vehicle.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#addVehicleType(basics.route.VehicleType)">addVehicleType</A></B>(<A HREF="../basics/route/VehicleType.html" title="interface in basics.route">VehicleType</A> type)</CODE>
|
|
|
|
<BR>
|
|
Adds a vehicleType.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.html" title="class in basics">VehicleRoutingProblem</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#build()">build</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Builds the <A HREF="../basics/VehicleRoutingProblem.html" title="class in basics"><CODE>VehicleRoutingProblem</CODE></A>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#createLocation(double, double)">createLocation</A></B>(double x,
|
|
double y)</CODE>
|
|
|
|
<BR>
|
|
Create a location (i.e.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Collection<<A HREF="../basics/Service.html" title="class in basics">Service</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#getAddedServices()">getAddedServices</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets an unmodifiable collection of already added services.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Collection<<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#getAddedVehicles()">getAddedVehicles</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets an unmodifiable collection of already added vehicles.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Map<java.lang.String,<A HREF="../util/Coordinate.html" title="class in util">Coordinate</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#getLocationMap()">getLocationMap</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the unmodifiable map of locations (mapped by their id).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../util/Locations.html" title="interface in util">Locations</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#getLocations()">getLocations</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the locations collected by this builder.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#newInstance()">newInstance</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns a new instance of this builder.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#setActivityCosts(basics.costs.VehicleRoutingActivityCosts)">setActivityCosts</A></B>(<A HREF="../basics/costs/VehicleRoutingActivityCosts.html" title="interface in basics.costs">VehicleRoutingActivityCosts</A> activityCosts)</CODE>
|
|
|
|
<BR>
|
|
Sets the activityCostFunction that considers also activities on a vehicle-route.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#setFleetComposition(basics.VehicleRoutingProblem.FleetComposition)">setFleetComposition</A></B>(<A HREF="../basics/VehicleRoutingProblem.FleetComposition.html" title="enum in basics">VehicleRoutingProblem.FleetComposition</A> fleetComposition)</CODE>
|
|
|
|
<BR>
|
|
Sets the fleetComposition.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#setFleetSize(basics.VehicleRoutingProblem.FleetSize)">setFleetSize</A></B>(<A HREF="../basics/VehicleRoutingProblem.FleetSize.html" title="enum in basics">VehicleRoutingProblem.FleetSize</A> fleetSize)</CODE>
|
|
|
|
<BR>
|
|
Sets the type of fleetSize.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#setNeighborhood(util.Neighborhood)">setNeighborhood</A></B>(<A HREF="../util/Neighborhood.html" title="interface in util">Neighborhood</A> neighborhood)</CODE>
|
|
|
|
<BR>
|
|
Sets the neighborhood.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../basics/VehicleRoutingProblem.Builder.html#setRoutingCost(basics.costs.VehicleRoutingTransportCosts)">setRoutingCost</A></B>(<A HREF="../basics/costs/VehicleRoutingTransportCosts.html" title="interface in basics.costs">VehicleRoutingTransportCosts</A> costs)</CODE>
|
|
|
|
<BR>
|
|
Sets routing costs.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="VehicleRoutingProblem.Builder()"><!-- --></A><H3>
|
|
VehicleRoutingProblem.Builder</H3>
|
|
<PRE>
|
|
public <B>VehicleRoutingProblem.Builder</B>()</PRE>
|
|
<DL>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="newInstance()"><!-- --></A><H3>
|
|
newInstance</H3>
|
|
<PRE>
|
|
public static <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>newInstance</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns a new instance of this builder.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>builder</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="createLocation(double, double)"><!-- --></A><H3>
|
|
createLocation</H3>
|
|
<PRE>
|
|
public java.lang.String <B>createLocation</B>(double x,
|
|
double y)</PRE>
|
|
<DL>
|
|
<DD>Create a location (i.e. coordinate) and returns the key of the location which is Coordinate.toString().
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>x</CODE> - <DD><CODE>y</CODE> -
|
|
<DT><B>Returns:</B><DD>locationId<DT><B>See Also:</B><DD><A HREF="../util/Coordinate.html" title="class in util"><CODE>Coordinate</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLocationMap()"><!-- --></A><H3>
|
|
getLocationMap</H3>
|
|
<PRE>
|
|
public java.util.Map<java.lang.String,<A HREF="../util/Coordinate.html" title="class in util">Coordinate</A>> <B>getLocationMap</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the unmodifiable map of locations (mapped by their id).
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLocations()"><!-- --></A><H3>
|
|
getLocations</H3>
|
|
<PRE>
|
|
public <A HREF="../util/Locations.html" title="interface in util">Locations</A> <B>getLocations</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the locations collected by this builder.
|
|
|
|
<p>Locations are cached when adding a shipment, service, depot, vehicle.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>locations</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addProblemConstraint(basics.VehicleRoutingProblem.Constraint)"><!-- --></A><H3>
|
|
addProblemConstraint</H3>
|
|
<PRE>
|
|
public void <B>addProblemConstraint</B>(<A HREF="../basics/VehicleRoutingProblem.Constraint.html" title="enum in basics">VehicleRoutingProblem.Constraint</A> constraint)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRoutingCost(basics.costs.VehicleRoutingTransportCosts)"><!-- --></A><H3>
|
|
setRoutingCost</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>setRoutingCost</B>(<A HREF="../basics/costs/VehicleRoutingTransportCosts.html" title="interface in basics.costs">VehicleRoutingTransportCosts</A> costs)</PRE>
|
|
<DL>
|
|
<DD>Sets routing costs.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>costs</CODE> -
|
|
<DT><B>Returns:</B><DD>builder<DT><B>See Also:</B><DD><A HREF="../basics/costs/VehicleRoutingTransportCosts.html" title="interface in basics.costs"><CODE>VehicleRoutingTransportCosts</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setFleetSize(basics.VehicleRoutingProblem.FleetSize)"><!-- --></A><H3>
|
|
setFleetSize</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>setFleetSize</B>(<A HREF="../basics/VehicleRoutingProblem.FleetSize.html" title="enum in basics">VehicleRoutingProblem.FleetSize</A> fleetSize)</PRE>
|
|
<DL>
|
|
<DD>Sets the type of fleetSize.
|
|
|
|
<p>FleetSize is either FleetSize.INFINITE or FleetSize.FINITE
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>fleetSize</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setFleetComposition(basics.VehicleRoutingProblem.FleetComposition)"><!-- --></A><H3>
|
|
setFleetComposition</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>setFleetComposition</B>(<A HREF="../basics/VehicleRoutingProblem.FleetComposition.html" title="enum in basics">VehicleRoutingProblem.FleetComposition</A> fleetComposition)</PRE>
|
|
<DL>
|
|
<DD>Sets the fleetComposition.
|
|
|
|
<p>FleetComposition is either FleetComposition.HETEROGENEOUS or FleetComposition.HOMOGENEOUS
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>fleetComposition</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addService(basics.Service)"><!-- --></A><H3>
|
|
addService</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addService</B>(<A HREF="../basics/Service.html" title="class in basics">Service</A> service)</PRE>
|
|
<DL>
|
|
<DD>Adds a service to jobList.
|
|
|
|
<p>If jobList already contains service, a warning message is printed, and the existing job will be overwritten.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>service</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addJob(basics.Job)"><!-- --></A><H3>
|
|
addJob</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addJob</B>(<A HREF="../basics/Job.html" title="interface in basics">Job</A> job)</PRE>
|
|
<DL>
|
|
<DD>Adds a job which is either a service or a shipment.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>job</CODE> -
|
|
<DT><B>Returns:</B><DD>
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.IllegalStateException</CODE> - if job is neither a shipment or a service.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addVehicle(basics.route.Vehicle)"><!-- --></A><H3>
|
|
addVehicle</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addVehicle</B>(<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A> vehicle)</PRE>
|
|
<DL>
|
|
<DD>Adds a vehicle.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>vehicle</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addVehicleType(basics.route.VehicleType)"><!-- --></A><H3>
|
|
addVehicleType</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addVehicleType</B>(<A HREF="../basics/route/VehicleType.html" title="interface in basics.route">VehicleType</A> type)</PRE>
|
|
<DL>
|
|
<DD>Adds a vehicleType.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>type</CODE> -
|
|
<DT><B>Returns:</B><DD>builder</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNeighborhood(util.Neighborhood)"><!-- --></A><H3>
|
|
setNeighborhood</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>setNeighborhood</B>(<A HREF="../util/Neighborhood.html" title="interface in util">Neighborhood</A> neighborhood)</PRE>
|
|
<DL>
|
|
<DD>Sets the neighborhood.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>neighborhood</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setActivityCosts(basics.costs.VehicleRoutingActivityCosts)"><!-- --></A><H3>
|
|
setActivityCosts</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>setActivityCosts</B>(<A HREF="../basics/costs/VehicleRoutingActivityCosts.html" title="interface in basics.costs">VehicleRoutingActivityCosts</A> activityCosts)</PRE>
|
|
<DL>
|
|
<DD>Sets the activityCostFunction that considers also activities on a vehicle-route.
|
|
|
|
<p>Here you can consider missed time-windows for example. By default, this is set to a DefaultVehicleActivityCostFunction.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>activityCosts</CODE> -
|
|
<DT><B>Returns:</B><DD><DT><B>See Also:</B><DD><CODE>VehicleRoutingTransportCosts, DefaultVehicleRouteCostFunction</CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="build()"><!-- --></A><H3>
|
|
build</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.html" title="class in basics">VehicleRoutingProblem</A> <B>build</B>()</PRE>
|
|
<DL>
|
|
<DD>Builds the <A HREF="../basics/VehicleRoutingProblem.html" title="class in basics"><CODE>VehicleRoutingProblem</CODE></A>.
|
|
|
|
<p>If <A HREF="../basics/costs/VehicleRoutingTransportCosts.html" title="interface in basics.costs"><CODE>VehicleRoutingTransportCosts</CODE></A> are not set, <A HREF="../util/CrowFlyCosts.html" title="class in util"><CODE>CrowFlyCosts</CODE></A> is used.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD><A HREF="../basics/VehicleRoutingProblem.html" title="class in basics"><CODE>VehicleRoutingProblem</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addLocation(java.lang.String, util.Coordinate)"><!-- --></A><H3>
|
|
addLocation</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addLocation</B>(java.lang.String id,
|
|
<A HREF="../util/Coordinate.html" title="class in util">Coordinate</A> coord)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addAllJobs(java.util.Collection)"><!-- --></A><H3>
|
|
addAllJobs</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addAllJobs</B>(java.util.Collection<<A HREF="../basics/Job.html" title="interface in basics">Job</A>> jobs)</PRE>
|
|
<DL>
|
|
<DD>Adds a collection of jobs.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobs</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addAllVehicles(java.util.Collection)"><!-- --></A><H3>
|
|
addAllVehicles</H3>
|
|
<PRE>
|
|
public <A HREF="../basics/VehicleRoutingProblem.Builder.html" title="class in basics">VehicleRoutingProblem.Builder</A> <B>addAllVehicles</B>(java.util.Collection<<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A>> vehicles)</PRE>
|
|
<DL>
|
|
<DD>Adds a collection of vehicles.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>vehicles</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAddedVehicles()"><!-- --></A><H3>
|
|
getAddedVehicles</H3>
|
|
<PRE>
|
|
public java.util.Collection<<A HREF="../basics/route/Vehicle.html" title="interface in basics.route">Vehicle</A>> <B>getAddedVehicles</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets an unmodifiable collection of already added vehicles.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>collection of vehicles</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAddedServices()"><!-- --></A><H3>
|
|
getAddedServices</H3>
|
|
<PRE>
|
|
public java.util.Collection<<A HREF="../basics/Service.html" title="class in basics">Service</A>> <B>getAddedServices</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets an unmodifiable collection of already added services.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>collection of services</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VehicleRoutingProblem.Builder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../basics/VehicleRoutingProblem.html" title="class in basics"><B>PREV CLASS</B></A>
|
|
<A HREF="../basics/VehicleRoutingProblem.Constraint.html" title="enum in basics"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../index.html?basics/VehicleRoutingProblem.Builder.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="VehicleRoutingProblem.Builder.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|