com.esri.arcgis.networkanalyst
Interface INAServerVRPParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerVRPParams

public interface INAServerVRPParams
extends INAServerSolverParams, Serializable

Provides access to properties that specify the Vehicle Routing Problem solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerVRPParams provides methods to set input parameters on an NAServerVRPParams object that is then used by the Solve method on INAServer to perform vehicle routing problem analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
INAServerLocations	getBreaks() RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
INAServerLocations	getDepots() RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.
String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
int	getDirectionsOutputType() Type of directions to generate.
String	getDirectionsStyleName() Name of the directions style to use when generating directions.
String	getDirectionsTimeAttributeName() Name of network attribute to use for the drive time when computing directions.
INAServerLocations	getOrderPairs() RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
INAServerLocations	getOrders() RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
INAServerLocations	getRouteRenewals() RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
INAServerLocations	getRoutes() RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
INAServerLocations	getRouteSeedPoints() RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
INAServerLocations	getRouteZones() RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.
INAServerLocations	getSpecialties() RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnBreaks() Indicates if the output Breaks recordset should be returned with the analysis results.
boolean	isReturnCompactDirections() Indicates if compact directions should be generated and returned with the analysis results.
boolean	isReturnDepots() Indicates if the output Depots recordset should be returned with the analysis results.
boolean	isReturnDepotVisits() Indicates if the output Depot Visits recordset should be returned with the analysis results.
boolean	isReturnOrderPairs() Indicates if the output OrderPairs recordset should be returned with the analysis results.
boolean	isReturnOrders() Indicates if the output Orders recordset should be returned with the analysis results.
boolean	isReturnPolygonBarriers() Indicates if the output polygon barriers recordset should be returned with the analysis results.
boolean	isReturnPolylineBarriers() Indicates if the output polyline barriers recordset should be returned with the analysis results.
boolean	isReturnRouteRenewals() Indicates if the output Route Renewals recordset should be returned with the analysis results.
boolean	isReturnRoutes() Indicates if the output Routes recordset should be returned with the analysis results.
boolean	isReturnRouteSeedPoints() Indicates if the Route Seed Points recordset should be returned with the analysis results.
boolean	isReturnRouteZones() Indicates if the Route Zones recordset should be returned with the analysis results.
boolean	isReturnSpecialties() Indicates if the Specialties recordset should be returned with the analysis results.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setBreaksByRef(INAServerLocations breaks) RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
void	setDepotsByRef(INAServerLocations depots) RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.
void	setDirectionsLanguage(String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsOutputType(int directionsOutputType) Type of directions to generate.
void	setDirectionsStyleName(String directionsStyleName) Name of the directions style to use when generating directions.
void	setDirectionsTimeAttributeName(String directionsTimeAttributeName) Name of network attribute to use for the drive time when computing directions.
void	setOrderPairsByRef(INAServerLocations orderPairs) RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
void	setOrdersByRef(INAServerLocations orders) RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
void	setPolygonBarriersByRef(INAServerLocations polygonBarriers) RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations polylineBarriers) RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnBreaks(boolean returnBreaks) Indicates if the output Breaks recordset should be returned with the analysis results.
void	setReturnCompactDirections(boolean returnCompactDirections) Indicates if compact directions should be generated and returned with the analysis results.
void	setReturnDepots(boolean returnDepots) Indicates if the output Depots recordset should be returned with the analysis results.
void	setReturnDepotVisits(boolean returnDepotVisits) Indicates if the output Depot Visits recordset should be returned with the analysis results.
void	setReturnOrderPairs(boolean returnOrderPairs) Indicates if the output OrderPairs recordset should be returned with the analysis results.
void	setReturnOrders(boolean returnOrders) Indicates if the output Orders recordset should be returned with the analysis results.
void	setReturnPolygonBarriers(boolean returnBarriers) Indicates if the output polygon barriers recordset should be returned with the analysis results.
void	setReturnPolylineBarriers(boolean returnBarriers) Indicates if the output polyline barriers recordset should be returned with the analysis results.
void	setReturnRouteRenewals(boolean returnRouteRenewals) Indicates if the output Route Renewals recordset should be returned with the analysis results.
void	setReturnRoutes(boolean returnRoutes) Indicates if the output Routes recordset should be returned with the analysis results.
void	setReturnRouteSeedPoints(boolean returnRouteSeedPoints) Indicates if the Route Seed Points recordset should be returned with the analysis results.
void	setReturnRouteZones(boolean returnRouteZones) Indicates if the Route Zones recordset should be returned with the analysis results.
void	setReturnSpecialties(boolean returnSpecialties) Indicates if the Specialties recordset should be returned with the analysis results.
void	setRouteRenewalsByRef(INAServerLocations routeRenewals) RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
void	setRoutesByRef(INAServerLocations routes) RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
void	setRouteSeedPointsByRef(INAServerLocations routeSeedPoints) RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
void	setRouteZonesByRef(INAServerLocations routeZones) RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.
void	setSpecialtiesByRef(INAServerLocations specialties) RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Method Detail

setOrdersByRef

void setOrdersByRef(INAServerLocations orders)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.

Remarks

Orders specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

orders - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrders

INAServerLocations getOrders()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepotsByRef

void setDepotsByRef(INAServerLocations depots)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.

Remarks

Depots specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

depots - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepots

INAServerLocations getDepots()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Depots loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRoutesByRef

void setRoutesByRef(INAServerLocations routes)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.

Remarks

Routes specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

routes - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRoutes

INAServerLocations getRoutes()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreaksByRef

void setBreaksByRef(INAServerLocations breaks)
                    throws IOException,
                           AutomationException

RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.

Remarks

Breaks specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

breaks - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreaks

INAServerLocations getBreaks()
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteZonesByRef

void setRouteZonesByRef(INAServerLocations routeZones)
                        throws IOException,
                               AutomationException

RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.

Remarks

RouteZones specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

routeZones - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteZones

INAServerLocations getRouteZones()
                                 throws IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteSeedPointsByRef

void setRouteSeedPointsByRef(INAServerLocations routeSeedPoints)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Remarks

RouteSeedPoints specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

routeSeedPoints - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteSeedPoints

INAServerLocations getRouteSeedPoints()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteRenewalsByRef

void setRouteRenewalsByRef(INAServerLocations routeRenewals)
                           throws IOException,
                                  AutomationException

RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.

Remarks

RouteRenewals specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

routeRenewals - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteRenewals

INAServerLocations getRouteRenewals()
                                    throws IOException,
                                           AutomationException

RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpecialtiesByRef

void setSpecialtiesByRef(INAServerLocations specialties)
                         throws IOException,
                                AutomationException

RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.

Remarks

Specialties specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

specialties - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecialties

INAServerLocations getSpecialties()
                                  throws IOException,
                                         AutomationException

RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderPairsByRef

void setOrderPairsByRef(INAServerLocations orderPairs)
                        throws IOException,
                               AutomationException

RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.

Remarks

OrderPairs specifies an instance of NAServerLocations class to use as input when solving a vehicle routing problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

orderPairs - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderPairs

INAServerLocations getOrderPairs()
                                 throws IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Remarks

PolylineBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

polylineBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

INAServerLocations getPolylineBarriers()
                                       throws IOException,
                                              AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonBarriersByRef

void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Remarks

PolygonBarriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

polygonBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

INAServerLocations getPolygonBarriers()
                                      throws IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnOrderPairs

void setReturnOrderPairs(boolean returnOrderPairs)
                         throws IOException,
                                AutomationException

Indicates if the output OrderPairs recordset should be returned with the analysis results.

Remarks

ReturnOrderPairs indicates if the order pairs used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnOrderPairs - The returnOrderPairs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnOrderPairs

boolean isReturnOrderPairs()
                           throws IOException,
                                  AutomationException

Indicates if the output OrderPairs recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnOrderPairs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnOrders

void setReturnOrders(boolean returnOrders)
                     throws IOException,
                            AutomationException

Indicates if the output Orders recordset should be returned with the analysis results.

Remarks

ReturnOrders indicates if the orders used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnOrders - The returnOrders (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnOrders

boolean isReturnOrders()
                       throws IOException,
                              AutomationException

Indicates if the output Orders recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnOrders

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDepots

void setReturnDepots(boolean returnDepots)
                     throws IOException,
                            AutomationException

Indicates if the output Depots recordset should be returned with the analysis results.

Remarks

ReturnDepots indicates if the depots used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnDepots - The returnDepots (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDepots

boolean isReturnDepots()
                       throws IOException,
                              AutomationException

Indicates if the output Depots recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnDepots

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnRoutes

void setReturnRoutes(boolean returnRoutes)
                     throws IOException,
                            AutomationException

Indicates if the output Routes recordset should be returned with the analysis results.

Remarks

ReturnRoutes indicates if the route features should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnRoutes - The returnRoutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRoutes

boolean isReturnRoutes()
                       throws IOException,
                              AutomationException

Indicates if the output Routes recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnRoutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDepotVisits

void setReturnDepotVisits(boolean returnDepotVisits)
                          throws IOException,
                                 AutomationException

Indicates if the output Depot Visits recordset should be returned with the analysis results.

Remarks

ReturnDepotVisits indicates if the depot visits features should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnDepotVisits - The returnDepotVisits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDepotVisits

boolean isReturnDepotVisits()
                            throws IOException,
                                   AutomationException

Indicates if the output Depot Visits recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnDepotVisits

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBreaks

void setReturnBreaks(boolean returnBreaks)
                     throws IOException,
                            AutomationException

Indicates if the output Breaks recordset should be returned with the analysis results.

Remarks

ReturnBreaks indicates if the breaks used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBreaks - The returnBreaks (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBreaks

boolean isReturnBreaks()
                       throws IOException,
                              AutomationException

Indicates if the output Breaks recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBreaks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnRouteRenewals

void setReturnRouteRenewals(boolean returnRouteRenewals)
                            throws IOException,
                                   AutomationException

Indicates if the output Route Renewals recordset should be returned with the analysis results.

Remarks

ReturnRouteRenewals indicates if the route renewals used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnRouteRenewals - The returnRouteRenewals (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRouteRenewals

boolean isReturnRouteRenewals()
                              throws IOException,
                                     AutomationException

Indicates if the output Route Renewals recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnRouteRenewals

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnRouteSeedPoints

void setReturnRouteSeedPoints(boolean returnRouteSeedPoints)
                              throws IOException,
                                     AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Remarks

ReturnRouteSeedPoints indicates if the route seed points used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnRouteSeedPoints - The returnRouteSeedPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRouteSeedPoints

boolean isReturnRouteSeedPoints()
                                throws IOException,
                                       AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnRouteSeedPoints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnRouteZones

void setReturnRouteZones(boolean returnRouteZones)
                         throws IOException,
                                AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Remarks

ReturnRouteZones indicates if the route zones used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnRouteZones - The returnRouteZones (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnRouteZones

boolean isReturnRouteZones()
                           throws IOException,
                                  AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnRouteZones

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnSpecialties

void setReturnSpecialties(boolean returnSpecialties)
                          throws IOException,
                                 AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Remarks

ReturnSpecialties indicates if the route specialties used during analysis should be returned as a RecordSet.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnSpecialties - The returnSpecialties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnSpecialties

boolean isReturnSpecialties()
                            throws IOException,
                                   AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnSpecialties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws IOException,
                              AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Remarks

ReturnBarriers specifies if the Barriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolylineBarriers

void setReturnPolylineBarriers(boolean returnBarriers)
                               throws IOException,
                                      AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Remarks

ReturnPolylineBarriers specifies if the PolylineBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolylineBarriers

boolean isReturnPolylineBarriers()
                                 throws IOException,
                                        AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnPolygonBarriers

void setReturnPolygonBarriers(boolean returnBarriers)
                              throws IOException,
                                     AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Remarks

ReturnPolygonBarriers specifies if the PolygonBarriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPolygonBarriers

boolean isReturnPolygonBarriers()
                                throws IOException,
                                       AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnCompactDirections

void setReturnCompactDirections(boolean returnCompactDirections)
                                throws IOException,
                                       AutomationException

Indicates if compact directions should be generated and returned with the analysis results.

Remarks

ReturnCompactDirections indicates if compact driving directions should be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnCompactDirections - The returnCompactDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCompactDirections

boolean isReturnCompactDirections()
                                  throws IOException,
                                         AutomationException

Indicates if compact directions should be generated and returned with the analysis results.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnCompactDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

void setDirectionsLanguage(String directionsLanguage)
                           throws IOException,
                                  AutomationException

Language to use when computing directions.

Remarks

DirectionsLanguage specifies the language used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

String getDirectionsLanguage()
                             throws IOException,
                                    AutomationException

Language to use when computing directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The directionsLanguage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

void setDirectionsLengthUnits(int directionsLengthUnits)
                              throws IOException,
                                     AutomationException

Length units to use when computing directions.

Remarks

DirectionsLengthUnits specifies the length units of the directions in esriNetworkAttributeUnits.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsLengthUnits - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

int getDirectionsLengthUnits()
                             throws IOException,
                                    AutomationException

Length units to use when computing directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsOutputType

void setDirectionsOutputType(int directionsOutputType)
                             throws IOException,
                                    AutomationException

Type of directions to generate.

Remarks

DirectionsOutputType defines the type of content of directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsOutputType

int getDirectionsOutputType()
                            throws IOException,
                                   AutomationException

Type of directions to generate.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsStyleName

void setDirectionsStyleName(String directionsStyleName)
                            throws IOException,
                                   AutomationException

Name of the directions style to use when generating directions.

Remarks

DirectionsStyleName defines name of the formatting style of directions. For the list of supported styles see NAServer.GetNetworkDescription() and NAServerNetworkDirections class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsStyleName - The directionsStyleName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsStyleName

String getDirectionsStyleName()
                              throws IOException,
                                     AutomationException

Name of the directions style to use when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The directionsStyleName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

void setDirectionsTimeAttributeName(String directionsTimeAttributeName)
                                    throws IOException,
                                           AutomationException

Name of network attribute to use for the drive time when computing directions.

Remarks

DirectionsTimeAttributeName specifies the time cost attribute used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

String getDirectionsTimeAttributeName()
                                      throws IOException,
                                             AutomationException

Name of network attribute to use for the drive time when computing directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The directionsTimeAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.