com.esri.arcgis.networkanalyst
Interface INATraversalResultEdit

All Superinterfaces:
Serializable
All Known Implementing Classes:
NATraversalResult

public interface INATraversalResultEdit
extends Serializable

Provides access to the editable properties of a traversal result.

Remarks

The INATraversalResultEdit interface provides methods to update the NATraversalResult object.

Product Availability

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


Method Summary
 int createEdge(int sourceID, int sourceOID, double fromPosition, double toPosition, int fromJunctionID, int toJunctionID, IPolyline polyline)
          Make a new edge in the result.
 int createJunction(int sourceID, int sourceOID, IPoint point)
          Make a new junction in the result.
 int createSimpleTurn(int sourceID, int sourceOID, int fromEdgeID, int toEdgeID)
          Make a new two edge turn in the result.
 void inferGeometry(String sourceName, IEnvelope envelope, ITrackCancel trackCancel)
          Constructs the geometry for the result.
 void startEditing()
          Starts editing the result..
 void stopEditing()
          Stops editing the result.
 void writeEdgeBuffer(IFeatureBuffer featureBuffer, int sourceID, int sourceOID, double fromPosition, double toPosition, int fromJunctionID, int toJunctionID, IPolyline polyline)
          Make a new edge in the result from the feature buffer.
 void writeJunctionBuffer(IFeatureBuffer featureBuffer, int sourceID, int sourceOID, IPoint point)
          Make a new junction in the result from the feature buffer.
 void writeSimpleTurnBuffer(IFeatureBuffer featureBuffer, int sourceID, int sourceOID, int fromEdgeID, int toEdgeID)
          Make a new two part turn in the result from the feature buffer.
 

Method Detail

startEditing

void startEditing()
                  throws IOException,
                         AutomationException
Starts editing the result..

Remarks

The method StartEditing puts the traversal result in a state to quickly add NATraversalResultElements to the underlying feature classes.

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.

stopEditing

void stopEditing()
                 throws IOException,
                        AutomationException
Stops editing the result.

Remarks

The method StopEditing should be called when the solver is done adding NATraversalResultElements to the traversal result's underlying feature classes.

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.

inferGeometry

void inferGeometry(String sourceName,
                   IEnvelope envelope,
                   ITrackCancel trackCancel)
                   throws IOException,
                          AutomationException
Constructs the geometry for the result.

Remarks

The InferGeometry method takes a source name (or an empty string which equates to all sources) as input and computes the geometry for each NATraversalResultElement based on its corresponding features in the NetworkDataset and NAContext.

Product Availability

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

Parameters:
sourceName - The sourceName (in)
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createJunction

int createJunction(int sourceID,
                   int sourceOID,
                   IPoint point)
                   throws IOException,
                          AutomationException
Make a new junction in the result.

Remarks

CreateJunction creates a junction in the traversal results junction feature class.

It is unnecessary to pass in a geometry. If passed in, it will be used. Otherwise, it is possible to call InferGeometry later to infer all of the geometries.

Product Availability

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

Parameters:
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:
The elementID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createEdge

int createEdge(int sourceID,
               int sourceOID,
               double fromPosition,
               double toPosition,
               int fromJunctionID,
               int toJunctionID,
               IPolyline polyline)
               throws IOException,
                      AutomationException
Make a new edge in the result.

Remarks

CreateEdge creates an edge in the traversal results edge feature class.

It is unnecessary to pass in a geometry. If passed in, it will be used. Otherwise, it is possible to call InferGeometry later to infer all of the geometries.

Product Availability

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

Parameters:
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
fromJunctionID - The fromJunctionID (in)
toJunctionID - The toJunctionID (in)
polyline - A reference to a com.esri.arcgis.geometry.IPolyline (in)
Returns:
The elementID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSimpleTurn

int createSimpleTurn(int sourceID,
                     int sourceOID,
                     int fromEdgeID,
                     int toEdgeID)
                     throws IOException,
                            AutomationException
Make a new two edge turn in the result.

Remarks

CreateSimpleTurn creates a turn between two edges in the traversal results turn feature class.

Product Availability

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

Parameters:
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
fromEdgeID - The fromEdgeID (in)
toEdgeID - The toEdgeID (in)
Returns:
The elementID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeJunctionBuffer

void writeJunctionBuffer(IFeatureBuffer featureBuffer,
                         int sourceID,
                         int sourceOID,
                         IPoint point)
                         throws IOException,
                                AutomationException
Make a new junction in the result from the feature buffer.

Remarks

WriteJunctionBuffer populates the input FeatureBuffer with the other input parameters. This FeatureBuffer can then be passed to an insert cursor on the traversal result feature class.

Product Availability

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

Parameters:
featureBuffer - A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer (in)
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeEdgeBuffer

void writeEdgeBuffer(IFeatureBuffer featureBuffer,
                     int sourceID,
                     int sourceOID,
                     double fromPosition,
                     double toPosition,
                     int fromJunctionID,
                     int toJunctionID,
                     IPolyline polyline)
                     throws IOException,
                            AutomationException
Make a new edge in the result from the feature buffer.

Remarks

WriteEdgeBuffer populates the input FeatureBuffer with the other input parameters. This FeatureBuffer can then be passed to an insert cursor on the traversal result feature class.

Product Availability

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

Parameters:
featureBuffer - A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer (in)
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
fromJunctionID - The fromJunctionID (in)
toJunctionID - The toJunctionID (in)
polyline - A reference to a com.esri.arcgis.geometry.IPolyline (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeSimpleTurnBuffer

void writeSimpleTurnBuffer(IFeatureBuffer featureBuffer,
                           int sourceID,
                           int sourceOID,
                           int fromEdgeID,
                           int toEdgeID)
                           throws IOException,
                                  AutomationException
Make a new two part turn in the result from the feature buffer.

Remarks

WriteSimpleTurnBuffer populates the input FeatureBuffer with the other input parameters. This FeatureBuffer can then be passed to an insert cursor on the traversal result feature class.

Product Availability

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

Parameters:
featureBuffer - A reference to a com.esri.arcgis.geodatabase.IFeatureBuffer (in)
sourceID - The sourceID (in)
sourceOID - The sourceOID (in)
fromEdgeID - The fromEdgeID (in)
toEdgeID - The toEdgeID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.