com.esri.arcgis.networkanalyst
Class NAServerClosestFacilityParams

java.lang.Object
  com.esri.arcgis.networkanalyst.NAServerClosestFacilityParams

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAClosestFacilitySolver, INAServerClosestFacilityParams, INAServerClosestFacilityParams2, INAServerSolverParams, INASolverSettings, INASolverSettings2, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerClosestFacilityParams
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerClosestFacilityParams, INAServerClosestFacilityParams2, INASolverSettings, INASolverSettings2, INAClosestFacilitySolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

A container for the closest facility solver settings and return parameters used by NAServer.

Remarks

NAServerClosestFacilityParams is used to pass solver settings and return parameters to the NAServer when performing stateless network analysis.

Product Availability

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings2

IID, IIDd3696546_2831_4aa5_a879_acd66e50a938, xxDummy

Constructor Summary

NAServerClosestFacilityParams()
Constructs a NAServerClosestFacilityParams using ArcGIS Engine.

NAServerClosestFacilityParams(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerClosestFacilityParams theNAServerClosestFacilityParams = (NAServerClosestFacilityParams) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IStringArray	getAccumulateAttributeNames() The collection of network attribute names to be accumulated with the analysis.
Object	getAttributeParameterValue(String attributeName, String paramName) The value to use for an attribute parameter within the network dataset.
INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getDefaultCutoff() The default cutoff value to stop traversing.
int	getDefaultTargetFacilityCount() The default number of facilities to find.
String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
String	getDirectionsTimeAttributeName() Name of network attribute to use for the drive time when computing directions.
INAServerLocations	getFacilities() RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
String	getHierarchyAttributeName() The name of the hierarchy attribute to be used in analysis.
int	getHierarchyLevelCount() The number of levels in the hierarchy attribute.
IImageDescription	getImageDescription() ImageDescription used when generating the MapImage returned with the analysis results.
String	getImpedanceAttributeName() The network attribute name to be used as the impedance attribute in analysis.
INAServerLocations	getIncidents() RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.
IMapDescription	getMapDescription() MapDescription used when generating the MapImage returned with the analysis results.
double	getMaxSnapTolerance() Maximum search tolerance used when attempting to load network locations.
int	getMaxValueForHierarchy(int level) The maximum value of the hierarchy attribute.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
INAClassCandidateFieldMap[]	getNAClassCandidateFieldMaps() Array of NAClassCandidateFieldMaps .
String	getNALayerName() Network analysis layer name.
int	getNumTransitionToHierarchy(int toLevel) The number of lower level junctions to explore before searching the next hierarchy level.
int	getOutputLines() Indicates how lines are generated.
ISpatialReference	getOutputSpatialReference() Spatial reference of the geometries returned with the analysis results.
IStringArray	getRestrictionAttributeNames() The collection of network attribute names to be used as restrictions with the analysis.
int	getRestrictUTurns() Indicates how U-Turns should be restricted in the analysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getSnapTolerance() Minimum search tolerance used when attempting to load network locations.
int	getSnapToleranceUnits() Length units of the SnapTolerance and MaxSnapTolerance.
int	getTravelDirection() The direction of the traversal.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isCreateTraversalResult() Indicates if a traversal result is created.
void	isDirty() isDirty
boolean	isIgnoreInvalidLocations() Indicates if invalid locations should be ignored or raise an error.
boolean	isResetHierarchyRangesOnBind() Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnCFRouteGeometries() Indicates if the CFRoute geometries should be generated and returned with the analysis results.
boolean	isReturnCFRoutes() Indicates if the output CFRoutes recordset should be returned with the analysis results.
boolean	isReturnCompactDirections() Indicates if compact directions should be generated and returned with the analysis results.
boolean	isReturnDirections() Indicates if directions should be generated and returned with the analysis results.
boolean	isReturnFacilities() Indicates if the output facilities recordset should be returned with the analysis results.
boolean	isReturnIncidents() Indicates if the output incidents recordset should be returned with the analysis results.
boolean	isReturnMap() Indicates if a MapImage should be generated and returned with the analysis results.
boolean	isUseHierarchy() Indicates if the hierarchy attribute for the network should be used in analysis.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAccumulateAttributeNamesByRef(IStringArray attributeNames) The collection of network attribute names to be accumulated with the analysis.
void	setAttributeParameterValue(String attributeName, String paramName, Object value) The value to use for an attribute parameter within the network dataset.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
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	setDirectionsLanguage(String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsTimeAttributeName(String directionsTimeAttributeName) Name of network attribute to use for the drive time when computing directions.
void	setFacilitiesByRef(INAServerLocations facilities) RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
void	setHierarchyAttributeName(String attributeName) The name of the hierarchy attribute to be used in analysis.
void	setHierarchyLevelCount(int count) The number of levels in the hierarchy attribute.
void	setIgnoreInvalidLocations(boolean ignoreInvalidLocations) Indicates if invalid locations should be ignored or raise an error.
void	setImageDescriptionByRef(IImageDescription imageDescription) ImageDescription used when generating the MapImage returned with the analysis results.
void	setImpedanceAttributeName(String attributeName) The network attribute name to be used as the impedance attribute in analysis.
void	setIncidentsByRef(INAServerLocations incidents) RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.
void	setMapDescriptionByRef(IMapDescription mapDescription) MapDescription used when generating the MapImage returned with the analysis results.
void	setMaxSnapTolerance(double maxSnapTolerance) Maximum search tolerance used when attempting to load network locations.
void	setMaxValueForHierarchy(int level, int value) The maximum value of the hierarchy attribute.
void	setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps) Array of NAClassCandidateFieldMaps .
void	setNALayerName(String nALayerName) Network analysis layer name.
void	setNumTransitionToHierarchy(int toLevel, int value) The number of lower level junctions to explore before searching the next hierarchy level.
void	setOutputLines(int value) Indicates how lines are generated.
void	setOutputSpatialReferenceByRef(ISpatialReference spatialReference) Spatial reference of the geometries returned with the analysis results.
void	setResetHierarchyRangesOnBind(boolean value) Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
void	setRestrictionAttributeNamesByRef(IStringArray attributeName) The collection of network attribute names to be used as restrictions with the analysis.
void	setRestrictUTurns(int backtrack) Indicates how U-Turns should be restricted in the analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnCFRouteGeometries(boolean returnCFRouteGeometries) Indicates if the CFRoute geometries should be generated and returned with the analysis results.
void	setReturnCFRoutes(boolean returnCFRoutes) Indicates if the output CFRoutes 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	setReturnDirections(boolean returnDirections) Indicates if directions should be generated and returned with the analysis results.
void	setReturnFacilities(boolean returnFacilities) Indicates if the output facilities recordset should be returned with the analysis results.
void	setReturnIncidents(boolean returnIncidents) Indicates if the output incidents recordset should be returned with the analysis results.
void	setReturnMap(boolean returnMap) Indicates if a MapImage should be generated and returned with the analysis results.
void	setSnapTolerance(double snapTolerance) Minimum search tolerance used when attempting to load network locations.
void	setSnapToleranceUnits(int snapToleranceUnits) Length units of the SnapTolerance and MaxSnapTolerance.
void	setTravelDirection(int value) The direction of the traversal.
void	setUseHierarchy(boolean useHierarchy) Indicates if the hierarchy attribute for the network should be used in analysis.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NAServerClosestFacilityParams

public NAServerClosestFacilityParams()
                              throws IOException,
                                     UnknownHostException

Constructs a NAServerClosestFacilityParams using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAServerClosestFacilityParams

public NAServerClosestFacilityParams(Object obj)
                              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerClosestFacilityParams theNAServerClosestFacilityParams = (NAServerClosestFacilityParams) obj;

Construct a NAServerClosestFacilityParams using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAServerClosestFacilityParams.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setNALayerName

public void setNALayerName(String nALayerName)
                    throws IOException,
                           AutomationException

Network analysis layer name.

Remarks

NALayerName specifies the Network Analyst Layer Name used within this NAContext.

Product Availability

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

Specified by:

setNALayerName in interface INAServerSolverParams

Parameters:

nALayerName - The nALayerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNALayerName

public String getNALayerName()
                      throws IOException,
                             AutomationException

Network analysis layer name.

Remarks

NALayerName specifies the Network Analyst Layer Name used within this NAContext.

Product Availability

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

Specified by:

getNALayerName in interface INAServerSolverParams

Returns:

The nALayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double snapTolerance)
                      throws IOException,
                             AutomationException

Minimum search tolerance used when attempting to load network locations.

Remarks

SnapTolerance specifies the minimum search tolerance used when finding network locations.

Product Availability

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

Specified by:

setSnapTolerance in interface INAServerSolverParams

Parameters:

snapTolerance - The snapTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

public double getSnapTolerance()
                        throws IOException,
                               AutomationException

Minimum search tolerance used when attempting to load network locations.

Remarks

SnapTolerance specifies the minimum search tolerance used when finding network locations.

Product Availability

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

Specified by:

getSnapTolerance in interface INAServerSolverParams

Returns:

The snapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSnapTolerance

public void setMaxSnapTolerance(double maxSnapTolerance)
                         throws IOException,
                                AutomationException

Maximum search tolerance used when attempting to load network locations.

Remarks

MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.

Product Availability

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

Specified by:

setMaxSnapTolerance in interface INAServerSolverParams

Parameters:

maxSnapTolerance - The maxSnapTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

public double getMaxSnapTolerance()
                           throws IOException,
                                  AutomationException

Maximum search tolerance used when attempting to load network locations.

Remarks

MaxSnapTolerance specifies the maximum search tolerance used when finding network locations.

Product Availability

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

Specified by:

getMaxSnapTolerance in interface INAServerSolverParams

Returns:

The maxSnapTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

public void setSnapToleranceUnits(int snapToleranceUnits)
                           throws IOException,
                                  AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Remarks

SnapToleranceUnits specifies the units of the search tolerance in esriUnits type.

Product Availability

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

Specified by:

setSnapToleranceUnits in interface INAServerSolverParams

Parameters:

snapToleranceUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws IOException,
                                 AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Remarks

SnapToleranceUnits specifies the units of the search tolerance in esriUnits type.

Product Availability

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

Specified by:

getSnapToleranceUnits in interface INAServerSolverParams

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws IOException,
                                         AutomationException

Array of NAClassCandidateFieldMaps .

Remarks

NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.

Product Availability

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

Specified by:

setNAClassCandidateFieldMaps in interface INAServerSolverParams

Parameters:

ppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNAClassCandidateFieldMaps

public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws IOException,
                                                                AutomationException

Array of NAClassCandidateFieldMaps .

Remarks

NAClassCandidateFieldMaps specifies the candidate fields for each NAClass. These field maps are used when loading network locations to map input fields with NAClass fields.

Product Availability

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

Specified by:

getNAClassCandidateFieldMaps in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnMap

public void setReturnMap(boolean returnMap)
                  throws IOException,
                         AutomationException

Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:

setReturnMap in interface INAServerSolverParams

Parameters:

returnMap - The returnMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnMap

public boolean isReturnMap()
                    throws IOException,
                           AutomationException

Indicates if a MapImage should be generated and returned with the analysis results.

Remarks

ReturnMap specifies if the map is returned by the solve.

Product Availability

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

Specified by:

isReturnMap in interface INAServerSolverParams

Returns:

The returnMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws IOException,
                                   AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Remarks

MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.

Product Availability

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

Specified by:

setMapDescriptionByRef in interface INAServerSolverParams

Parameters:

mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapDescription

public IMapDescription getMapDescription()
                                  throws IOException,
                                         AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Remarks

MapDescription specifies the MapDescription object to use when drawing the map with the analysis results.

Product Availability

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

Specified by:

getMapDescription in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.carto.IMapDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

public void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws IOException,
                                     AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

Specifies the ImageDescription used when creating maps during solve. Setting the Width and Height of the output map to be 200x200 pixels would look something like:

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:

setImageDescriptionByRef in interface INAServerSolverParams

Parameters:

imageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImageDescription

public IImageDescription getImageDescription()
                                      throws IOException,
                                             AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Remarks

Specifies the ImageDescription used when creating maps during solve. Setting the Width and Height of the output map to be 200x200 pixels would look something like:

routeParams.ImageDescription.Display.Width = 200

routeParams.ImageDescription.Display.Height = 200

Product Availability

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

Specified by:

getImageDescription in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.carto.IImageDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws IOException,
                                           AutomationException

Spatial reference of the geometries returned with the analysis results.

Remarks

OutputSpatialReference specifies the spatial reference of the resulting geometry arrays returned from Solve. This does not change the spatial reference of the recordsets returned which are in the spatial reference of the network dataset.

Product Availability

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

Specified by:

setOutputSpatialReferenceByRef in interface INAServerSolverParams

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Remarks

OutputSpatialReference specifies the spatial reference of the resulting geometry arrays returned from Solve. This does not change the spatial reference of the recordsets returned which are in the spatial reference of the network dataset.

Product Availability

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

Specified by:

getOutputSpatialReference in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFacilitiesByRef

public void setFacilitiesByRef(INAServerLocations facilities)
                        throws IOException,
                               AutomationException

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

Remarks

Facilities specifies the NALocations to take into account when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

setFacilitiesByRef in interface INAServerClosestFacilityParams

Parameters:

facilities - 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.

getFacilities

public INAServerLocations getFacilities()
                                 throws IOException,
                                        AutomationException

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

Remarks

Facilities specifies the NALocations to take into account when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

getFacilities in interface INAServerClosestFacilityParams

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.

setIncidentsByRef

public void setIncidentsByRef(INAServerLocations incidents)
                       throws IOException,
                              AutomationException

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

Remarks

Incidents specifies the NALocations to take into account when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

setIncidentsByRef in interface INAServerClosestFacilityParams

Parameters:

incidents - 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.

getIncidents

public INAServerLocations getIncidents()
                                throws IOException,
                                       AutomationException

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

Remarks

Incidents specifies the NALocations to take into account when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

getIncidents in interface INAServerClosestFacilityParams

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

public void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

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

Remarks

Barriers specifies the NALocations to use in order to restrict network elements when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

setBarriersByRef in interface INAServerClosestFacilityParams

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

public INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

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

Remarks

Barriers specifies the NALocations to use in order to restrict network elements when solving a Closest Facility problem. Valid values include an IRecordSet or an array of IPropertySet.

Product Availability

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

Specified by:

getBarriers in interface INAServerClosestFacilityParams

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.

setReturnCFRouteGeometries

public void setReturnCFRouteGeometries(boolean returnCFRouteGeometries)
                                throws IOException,
                                       AutomationException

Indicates if the CFRoute geometries should be generated and returned with the analysis results.

Remarks

ReturnCFRouteGeometries specifies if the Polylines for the resulting CFRoute features are returned.

Product Availability

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

Specified by:

setReturnCFRouteGeometries in interface INAServerClosestFacilityParams

Parameters:

returnCFRouteGeometries - The returnCFRouteGeometries (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCFRouteGeometries

public boolean isReturnCFRouteGeometries()
                                  throws IOException,
                                         AutomationException

Indicates if the CFRoute geometries should be generated and returned with the analysis results.

Remarks

ReturnCFRouteGeometries specifies if the Polylines for the resulting CFRoute features are returned.

Product Availability

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

Specified by:

isReturnCFRouteGeometries in interface INAServerClosestFacilityParams

Returns:

The returnCFRouteGeometries

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnCFRoutes

public void setReturnCFRoutes(boolean returnCFRoutes)
                       throws IOException,
                              AutomationException

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

Remarks

ReturnCFRoutes specifies if the resulting CFRoute features are returned.

Product Availability

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

Specified by:

setReturnCFRoutes in interface INAServerClosestFacilityParams

Parameters:

returnCFRoutes - The returnCFRoutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCFRoutes

public boolean isReturnCFRoutes()
                         throws IOException,
                                AutomationException

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

Remarks

ReturnCFRoutes specifies if the resulting CFRoute features are returned.

Product Availability

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

Specified by:

isReturnCFRoutes in interface INAServerClosestFacilityParams

Returns:

The returnCFRoutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

public void setReturnFacilities(boolean returnFacilities)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnFacilites specifies if the resulting Facility features are returned.

Product Availability

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

Specified by:

setReturnFacilities in interface INAServerClosestFacilityParams

Parameters:

returnFacilities - The returnFacilities (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

public boolean isReturnFacilities()
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnFacilites specifies if the resulting Facility features are returned.

Product Availability

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

Specified by:

isReturnFacilities in interface INAServerClosestFacilityParams

Returns:

The returnFacilities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnIncidents

public void setReturnIncidents(boolean returnIncidents)
                        throws IOException,
                               AutomationException

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

Remarks

ReturnIncidents specifies if the resulting Incident features are returned.

Product Availability

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

Specified by:

setReturnIncidents in interface INAServerClosestFacilityParams

Parameters:

returnIncidents - The returnIncidents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnIncidents

public boolean isReturnIncidents()
                          throws IOException,
                                 AutomationException

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

Remarks

ReturnIncidents specifies if the resulting Incident features are returned.

Product Availability

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

Specified by:

isReturnIncidents in interface INAServerClosestFacilityParams

Returns:

The returnIncidents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

public 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 resulting Barrier features are returned.

Product Availability

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

Specified by:

setReturnBarriers in interface INAServerClosestFacilityParams

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

public boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

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

Remarks

ReturnBarriers specifies if the resulting Barrier features are returned.

Product Availability

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

Specified by:

isReturnBarriers in interface INAServerClosestFacilityParams

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

public void setReturnDirections(boolean returnDirections)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerClosestFacilityResults.

Product Availability

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

Specified by:

setReturnDirections in interface INAServerClosestFacilityParams

Parameters:

returnDirections - The returnDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

public boolean isReturnDirections()
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerClosestFacilityResults.

Product Availability

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

Specified by:

isReturnDirections in interface INAServerClosestFacilityParams

Returns:

The returnDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

public 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.

Specified by:

setDirectionsLanguage in interface INAServerClosestFacilityParams

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

public String getDirectionsLanguage()
                             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.

Specified by:

getDirectionsLanguage in interface INAServerClosestFacilityParams

Returns:

The directionsLanguage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

public 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.

Specified by:

setDirectionsLengthUnits in interface INAServerClosestFacilityParams

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

public int getDirectionsLengthUnits()
                             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.

Specified by:

getDirectionsLengthUnits in interface INAServerClosestFacilityParams

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

public 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.

Specified by:

setDirectionsTimeAttributeName in interface INAServerClosestFacilityParams

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

public String getDirectionsTimeAttributeName()
                                      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.

Specified by:

getDirectionsTimeAttributeName in interface INAServerClosestFacilityParams

Returns:

The directionsTimeAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnCompactDirections

public void setReturnCompactDirections(boolean returnCompactDirections)
                                throws IOException,
                                       AutomationException

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

Remarks

ReturnCompactDirections specifies if compact directions are calculated during solve and returned in INAServerClosestFacilityResults2::CompactDirections. These directions contain less information and compressed geometries representing the traversed streets. Due to their smaller size, these directions are better suited for passing across low bandwidth connections than the directions returned by ReturnDirections.

Product Availability

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

Specified by:

setReturnCompactDirections in interface INAServerClosestFacilityParams2

Parameters:

returnCompactDirections - The returnCompactDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCompactDirections

public boolean isReturnCompactDirections()
                                  throws IOException,
                                         AutomationException

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

Remarks

ReturnCompactDirections specifies if compact directions are calculated during solve and returned in INAServerClosestFacilityResults2::CompactDirections. These directions contain less information and compressed geometries representing the traversed streets. Due to their smaller size, these directions are better suited for passing across low bandwidth connections than the directions returned by ReturnDirections.

Product Availability

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

Specified by:

isReturnCompactDirections in interface INAServerClosestFacilityParams2

Returns:

The returnCompactDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccumulateAttributeNames

public IStringArray getAccumulateAttributeNames()
                                         throws IOException,
                                                AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:

getAccumulateAttributeNames in interface INASolverSettings

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccumulateAttributeNamesByRef

public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
                                      throws IOException,
                                             AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:

setAccumulateAttributeNamesByRef in interface INASolverSettings

Parameters:

attributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setImpedanceAttributeName

public void setImpedanceAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:

setImpedanceAttributeName in interface INASolverSettings

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getImpedanceAttributeName

public String getImpedanceAttributeName()
                                 throws IOException,
                                        AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:

getImpedanceAttributeName in interface INASolverSettings

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
                               throws IOException,
                                      AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:

setIgnoreInvalidLocations in interface INASolverSettings

Parameters:

ignoreInvalidLocations - The ignoreInvalidLocations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIgnoreInvalidLocations

public boolean isIgnoreInvalidLocations()
                                 throws IOException,
                                        AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:

isIgnoreInvalidLocations in interface INASolverSettings

Returns:

The ignoreInvalidLocations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws IOException,
                                                 AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:

getRestrictionAttributeNames in interface INASolverSettings

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
                                       throws IOException,
                                              AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:

setRestrictionAttributeNamesByRef in interface INASolverSettings

Parameters:

attributeName - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws IOException,
                              AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:

setRestrictUTurns in interface INASolverSettings

Parameters:

backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRestrictUTurns

public int getRestrictUTurns()
                      throws IOException,
                             AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:

getRestrictUTurns in interface INASolverSettings

Returns:

A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws IOException,
                            AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:

setUseHierarchy in interface INASolverSettings

Parameters:

useHierarchy - The useHierarchy (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseHierarchy

public boolean isUseHierarchy()
                       throws IOException,
                              AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:

isUseHierarchy in interface INASolverSettings

Returns:

The useHierarchy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeName

public void setHierarchyAttributeName(String attributeName)
                               throws IOException,
                                      AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:

setHierarchyAttributeName in interface INASolverSettings

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyAttributeName

public String getHierarchyAttributeName()
                                 throws IOException,
                                        AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:

getHierarchyAttributeName in interface INASolverSettings

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws IOException,
                                   AutomationException

The number of levels in the hierarchy attribute.

Specified by:

setHierarchyLevelCount in interface INASolverSettings

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyLevelCount

public int getHierarchyLevelCount()
                           throws IOException,
                                  AutomationException

The number of levels in the hierarchy attribute.

Specified by:

getHierarchyLevelCount in interface INASolverSettings

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws IOException,
                                    AutomationException

The maximum value of the hierarchy attribute.

Specified by:

setMaxValueForHierarchy in interface INASolverSettings

Parameters:

level - The level (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws IOException,
                                   AutomationException

The maximum value of the hierarchy attribute.

Specified by:

getMaxValueForHierarchy in interface INASolverSettings

Parameters:

level - The level (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumTransitionToHierarchy

public void setNumTransitionToHierarchy(int toLevel,
                                        int value)
                                 throws IOException,
                                        AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:

setNumTransitionToHierarchy in interface INASolverSettings

Parameters:

toLevel - The toLevel (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumTransitionToHierarchy

public int getNumTransitionToHierarchy(int toLevel)
                                throws IOException,
                                       AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:

getNumTransitionToHierarchy in interface INASolverSettings

Parameters:

toLevel - The toLevel (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isResetHierarchyRangesOnBind

public boolean isResetHierarchyRangesOnBind()
                                     throws IOException,
                                            AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:

isResetHierarchyRangesOnBind in interface INASolverSettings2

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
                                   throws IOException,
                                          AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:

setResetHierarchyRangesOnBind in interface INASolverSettings2

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeParameterValue

public Object getAttributeParameterValue(String attributeName,
                                         String paramName)
                                  throws IOException,
                                         AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:

getAttributeParameterValue in interface INASolverSettings2

Parameters:

attributeName - The attributeName (in)

paramName - The paramName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributeParameterValue

public void setAttributeParameterValue(String attributeName,
                                       String paramName,
                                       Object value)
                                throws IOException,
                                       AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:

setAttributeParameterValue in interface INASolverSettings2

Parameters:

attributeName - The attributeName (in)

paramName - The paramName (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultTargetFacilityCount

public 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.

Specified by:

getDefaultTargetFacilityCount in interface INAClosestFacilitySolver

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultTargetFacilityCount

public 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.

Specified by:

setDefaultTargetFacilityCount in interface INAClosestFacilitySolver

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCutoff

public 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.

Specified by:

getDefaultCutoff in interface INAClosestFacilitySolver

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCutoff

public 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.

Specified by:

setDefaultCutoff in interface INAClosestFacilitySolver

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTravelDirection

public 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.

Specified by:

getTravelDirection in interface INAClosestFacilitySolver

Returns:

A com.esri.arcgis.networkanalyst.esriNATravelDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTravelDirection

public 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.

Specified by:

setTravelDirection in interface INAClosestFacilitySolver

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

public 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.

Specified by:

isCreateTraversalResult in interface INAClosestFacilitySolver

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreateTraversalResult

public 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.

Specified by:

setCreateTraversalResult in interface INAClosestFacilitySolver

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputLines

public 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.

Specified by:

getOutputLines in interface INAClosestFacilitySolver

Returns:

A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputLines

public 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.

Specified by:

setOutputLines in interface INAClosestFacilitySolver

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException