com.esri.arcgis.networkanalyst
Interface INAVRPSolver

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
INAVRPSolverProxy, NAServerVRPParams, NAVRPSolver

public interface INAVRPSolver
extends java.io.Serializable

COM Interface 'INAVRPSolver'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to the VRP solver.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID1ae9aa35_d121_4523_aed1_7d25dcabc3fc
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getCapacityCount()
          The number of dimensions for object sizes.
 java.util.Date getDefaultDate()
          The date to use for time windows without dates.
 int getDistanceFieldUnits()
          The units for distance fields in the NA classes.
 double getExcessTransitTimePenaltyFactor()
          The penalty factor for excess transit time in the objective function.
 INAODCostMatrix getExternalODCostMatrix()
          The external OD cost matrix object.
 int getInternalODCostMatrixType()
          Indicates the type of internal matrix to be created.
 int getOutputLines()
          Indicates how route lines are generated.
 int getTimeFieldUnits()
          The units for time fields in the NA classes.
 double getTimeWindowViolationPenaltyFactor()
          The penalty factor for time window violation in the objective function.
 boolean isGenerateInternalRouteContext()
          Indicates if the internal route context should be generated.
 void setCapacityCount(int value)
          The number of dimensions for object sizes.
 void setDefaultDate(java.util.Date date)
          The date to use for time windows without dates.
 void setDistanceFieldUnits(int units)
          The units for distance fields in the NA classes.
 void setExcessTransitTimePenaltyFactor(double value)
          The penalty factor for excess transit time in the objective function.
 void setExternalODCostMatrixByRef(INAODCostMatrix matrix)
          The external OD cost matrix object.
 void setGenerateInternalRouteContext(boolean value)
          Indicates if the internal route context should be generated.
 void setInternalODCostMatrixType(int type)
          Indicates the type of internal matrix to be created.
 void setOutputLines(int value)
          Indicates how route lines are generated.
 void setTimeFieldUnits(int units)
          The units for time fields in the NA classes.
 void setTimeWindowViolationPenaltyFactor(double value)
          The penalty factor for time window violation in the objective function.
 

Field Detail

IID1ae9aa35_d121_4523_aed1_7d25dcabc3fc

static final int IID1ae9aa35_d121_4523_aed1_7d25dcabc3fc
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getInternalODCostMatrixType

int getInternalODCostMatrixType()
                                throws java.io.IOException,
                                       AutomationException
Indicates the type of internal matrix to be created.

Returns:
A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInternalODCostMatrixType

void setInternalODCostMatrixType(int type)
                                 throws java.io.IOException,
                                        AutomationException
Indicates the type of internal matrix to be created.

Parameters:
type - A com.esri.arcgis.networkanalyst.esriNAODCostMatrixType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGenerateInternalRouteContext

boolean isGenerateInternalRouteContext()
                                       throws java.io.IOException,
                                              AutomationException
Indicates if the internal route context should be generated.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGenerateInternalRouteContext

void setGenerateInternalRouteContext(boolean value)
                                     throws java.io.IOException,
                                            AutomationException
Indicates if the internal route context should be generated.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExternalODCostMatrix

INAODCostMatrix getExternalODCostMatrix()
                                        throws java.io.IOException,
                                               AutomationException
The external OD cost matrix object.

Returns:
A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExternalODCostMatrixByRef

void setExternalODCostMatrixByRef(INAODCostMatrix matrix)
                                  throws java.io.IOException,
                                         AutomationException
The external OD cost matrix object.

Parameters:
matrix - A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeFieldUnits

int getTimeFieldUnits()
                      throws java.io.IOException,
                             AutomationException
The units for time fields in the NA classes.

Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeFieldUnits

void setTimeFieldUnits(int units)
                       throws java.io.IOException,
                              AutomationException
The units for time fields in the NA classes.

Parameters:
units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceFieldUnits

int getDistanceFieldUnits()
                          throws java.io.IOException,
                                 AutomationException
The units for distance fields in the NA classes.

Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceFieldUnits

void setDistanceFieldUnits(int units)
                           throws java.io.IOException,
                                  AutomationException
The units for distance fields in the NA classes.

Parameters:
units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDate

java.util.Date getDefaultDate()
                              throws java.io.IOException,
                                     AutomationException
The date to use for time windows without dates.

Returns:
The date
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultDate

void setDefaultDate(java.util.Date date)
                    throws java.io.IOException,
                           AutomationException
The date to use for time windows without dates.

Parameters:
date - The date (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCapacityCount

int getCapacityCount()
                     throws java.io.IOException,
                            AutomationException
The number of dimensions for object sizes.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCapacityCount

void setCapacityCount(int value)
                      throws java.io.IOException,
                             AutomationException
The number of dimensions for object sizes.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeWindowViolationPenaltyFactor

double getTimeWindowViolationPenaltyFactor()
                                           throws java.io.IOException,
                                                  AutomationException
The penalty factor for time window violation in the objective function.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeWindowViolationPenaltyFactor

void setTimeWindowViolationPenaltyFactor(double value)
                                         throws java.io.IOException,
                                                AutomationException
The penalty factor for time window violation in the objective function.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcessTransitTimePenaltyFactor

double getExcessTransitTimePenaltyFactor()
                                         throws java.io.IOException,
                                                AutomationException
The penalty factor for excess transit time in the objective function.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcessTransitTimePenaltyFactor

void setExcessTransitTimePenaltyFactor(double value)
                                       throws java.io.IOException,
                                              AutomationException
The penalty factor for excess transit time in the objective function.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputLines

int getOutputLines()
                   throws java.io.IOException,
                          AutomationException
Indicates how route lines are generated.

Returns:
A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputLines

void setOutputLines(int value)
                    throws java.io.IOException,
                           AutomationException
Indicates how route lines are generated.

Parameters:
value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.