com.esri.arcgis.networkanalyst
Interface INAResult

All Superinterfaces:
Serializable
All Known Subinterfaces:
INAResult2
All Known Implementing Classes:
NAODCostMatrixResult, NATraversalResult, NAVRPResult

public interface INAResult
extends Serializable

Provides access to the results of an analysis.

Superseded By

INAResult2

Remarks

The INAResult interface is a required interface on any network result. Objects implementing this interface may be returned by the Result property on INAContext.

This interface has methods to setup and clear the analysis results as well as methods to do high level interrogation of the results.

Product Availability

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


Method Summary
 void emptyAll()
          Clear out all existing rows from any previous analysis.
 INAContext getNAContext()
          The context for the result.
 String getName()
          The name of the result.
 IPropertySet getOutputProperties()
          The properties of the output.
 void initialize(String name, INAContext nAContext, boolean isScratch)
          Set up for a new analysis.
 boolean isHasValidResult()
          Indicates if the current result is valid.
 void setHasValidResult(boolean pFlag)
          Indicates if the current result is valid.
 

Method Detail

initialize

void initialize(String name,
                INAContext nAContext,
                boolean isScratch)
                throws IOException,
                       AutomationException
Set up for a new analysis.

Remarks

This method has been deprecated and should not be used. Instead, use INAResult2.Create to initialize a result object after creating it.

Product Availability

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

Parameters:
name - The name (in)
nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
isScratch - The isScratch (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputProperties

IPropertySet getOutputProperties()
                                 throws IOException,
                                        AutomationException
The properties of the output.

Remarks

The OutputProperties property returns a PropertySet that may contain information about the results of the network analysis.

The contents of the property set is up to the individual solver. For the solvers that ESRI has released, HasGapsInEdgeCumulativeImpedances returns True if there are impedance values on the junction elements that were traversed. This is important because measures are not generated on the resulting polyline feature class (Route, CFLines, SALines) in this case.

Closest Facility:

HasGapsInEdgeCumulativeImpedances True/False

Route:

HasGapsInEdgeCumulativeImpedances True/False

Service Area:

HasGapsInEdgeCumulativeImpedances True/False
TravelDirection TRAVEL_FROM/TRAVEL_TO

Origin Destination Cost Matrix:

** No TraversalResult generated

Product Availability

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

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

isHasValidResult

boolean isHasValidResult()
                         throws IOException,
                                AutomationException
Indicates if the current result is valid.

Remarks

The HasValidResult property denotes if network analysis has been performed and the result object has been populated with valid information.

Product Availability

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

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

setHasValidResult

void setHasValidResult(boolean pFlag)
                       throws IOException,
                              AutomationException
Indicates if the current result is valid.

Remarks

The HasValidResult property denotes if network analysis has been performed and the result object has been populated with valid information.

Product Availability

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

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

emptyAll

void emptyAll()
              throws IOException,
                     AutomationException
Clear out all existing rows from any previous analysis.

Remarks

Clears the traversal result.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
The name of the result.

Remarks

The Name property returns the name of the traversal result that was set during the call to Create.

Product Availability

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

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

getNAContext

INAContext getNAContext()
                        throws IOException,
                               AutomationException
The context for the result.

Remarks

The NAContext returns the context that this traversal result was based upon.

Product Availability

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

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