com.esri.arcgis.networkanalyst
Interface INAClosestFacilitySolver

All Superinterfaces:

Serializable

All Known Implementing Classes:

NAClosestFacilitySolver, NAServerClosestFacilityParams

public interface INAClosestFacilitySolver
extends Serializable

Provides access to the closest facility solver.

Remarks

INAClosestFacilitySolver is an interface provided on the NAClosestFacilitySolver and NAServerClosestFacilityParams objects to access the properties of the closest facility solver.

Product Availability

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

Method Summary

Object	getDefaultCutoff() The default cutoff value to stop traversing.
int	getDefaultTargetFacilityCount() The default number of facilities to find.
int	getOutputLines() Indicates how lines are generated.
int	getTravelDirection() The direction of the traversal.
boolean	isCreateTraversalResult() Indicates if a traversal result is created.
void	setCreateTraversalResult(boolean value) Indicates if a traversal result is created.
void	setDefaultCutoff(Object value) The default cutoff value to stop traversing.
void	setDefaultTargetFacilityCount(int value) The default number of facilities to find.
void	setOutputLines(int value) Indicates how lines are generated.
void	setTravelDirection(int value) The direction of the traversal.

Method Detail

getDefaultTargetFacilityCount

int getDefaultTargetFacilityCount()
                                  throws IOException,
                                         AutomationException

The default number of facilities to find.

Remarks

DefaultTargetFacilityCount specifies up to how many facilities to solve for. Solving for 10 facilities will return at the most 10 closest facilities from each incident. This property sets and gets the number of destinations to find for the NAClosestFacilitySolver.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTargetFacilityCount

void setDefaultTargetFacilityCount(int value)
                                   throws IOException,
                                          AutomationException

The default number of facilities to find.

Remarks

DefaultTargetFacilityCount specifies up to how many facilities to solve for. Solving for 10 facilities will return at the most 10 closest facilities from each incident. This property sets and gets the number of destinations to find for the NAClosestFacilitySolver.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCutoff

Object getDefaultCutoff()
                        throws IOException,
                               AutomationException

The default cutoff value to stop traversing.

Remarks

DefaultCutoff specifies how far to search for facilities from each incident. Setting a default cutoff of 10 miles will only return those facilities within 10 miles from each incident. This property sets and gets the cutoff value for the NAClosestFacilitySolver.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCutoff

void setDefaultCutoff(Object value)
                      throws IOException,
                             AutomationException

The default cutoff value to stop traversing.

Remarks

DefaultCutoff specifies how far to search for facilities from each incident. Setting a default cutoff of 10 miles will only return those facilities within 10 miles from each incident. This property sets and gets the cutoff value for the NAClosestFacilitySolver.

Product Availability

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

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTravelDirection

int getTravelDirection()
                       throws IOException,
                              AutomationException

The direction of the traversal.

Remarks

TravelDirection can be set to travel from the facility (default) or travel to the facility. This can make a difference in finding the closest facility if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network. This property sets and gets the travel direction for the NAClosestFacilitySolver.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNATravelDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTravelDirection

void setTravelDirection(int value)
                        throws IOException,
                               AutomationException

The direction of the traversal.

Remarks

TravelDirection can be set to travel from the facility (default) or travel to the facility. This can make a difference in finding the closest facility if there are oneway restrictions, turn restrictions, or different travel cost attributes for each side of the street in the network. This property sets and gets the travel direction for the NAClosestFacilitySolver.

Product Availability

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

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNATravelDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCreateTraversalResult

boolean isCreateTraversalResult()
                                throws IOException,
                                       AutomationException

Indicates if a traversal result is created.

Remarks

CreateTraversalResult specifies if the traversal results will be created by the closest facility solver. Not computing the traversal results can be faster if no output lines or straight lines are to be created. This property sets and gets the status as true or false for the NAClosestFacilitySolver.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreateTraversalResult

void setCreateTraversalResult(boolean value)
                              throws IOException,
                                     AutomationException

Indicates if a traversal result is created.

Remarks

CreateTraversalResult specifies if the traversal results will be created by the closest facility solver. Not computing the traversal results can be faster if no output lines or straight lines are to be created. This property sets and gets the status as true or false for the NAClosestFacilitySolver.

Product Availability

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputLines

int getOutputLines()
                   throws IOException,
                          AutomationException

Indicates how lines are generated.

Remarks

OutputLines specifies the type of lines to be generated by the closest facility solver. The choice is to the generate the true shapes, true shapes with measure, straight lines, or to generate no lines. This property sets and gets the output line type for the NAClosestFacilitySolver.

Product Availability

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

Returns:

A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputLines

void setOutputLines(int value)
                    throws IOException,
                           AutomationException

Indicates how lines are generated.

Remarks

OutputLines specifies the type of lines to be generated by the closest facility solver. The choice is to the generate the true shapes, straight lines, or to generate no lines. This property sets and gets the output line type for the NAClosestFacilitySolver.

Product Availability

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

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.