com.esri.arcgis.schematic
Interface ISchematicAnalystFindPath

All Superinterfaces:
ISchematicAlgorithm, ISchematicAnalystTraceResult, Serializable
All Known Implementing Classes:
SchematicAnalystFindPath

public interface ISchematicAnalystFindPath
extends ISchematicAnalystTraceResult, Serializable

Provides access to members that control the Find Path trace analyst.

Description

The Find Path schematic analyst trace task is used to detect the shortest path between two schematic nodes in the schematic network represented in a schematic diagram. If schematic links are selected in the diagram when the trace task is performed, they are interpreted as barriers that will stop the trace from executing beyond them.

Product Availability

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


Method Summary
 String getUserDataNameForLinkWeight()
          Name of the userdata that defines the links weight.
 String getUserDataNameOfForbiddenLinks()
          Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.
 boolean isSelectLink()
          Indicates if the schematic links that belong to the Find Path trace result must be selected.
 boolean isSelectNode()
          Indicates if the schematic nodes that belong to the Find Path trace result must be selected.
 void setSelectLink(boolean selectLink)
          Indicates if the schematic links that belong to the Find Path trace result must be selected.
 void setSelectNode(boolean selectNode)
          Indicates if the schematic nodes that belong to the Find Path trace result must be selected.
 void setUserDataNameForLinkWeight(String name)
          Name of the userdata that defines the links weight.
 void setUserDataNameOfForbiddenLinks(String name)
          Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.
 
Methods inherited from interface com.esri.arcgis.schematic.ISchematicAnalystTraceResult
clearResult, getTraceResult
 
Methods inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm
execute, getAlgorithmCLSID, getLabel, getPropertySet, getSchematicDiagramClassName, isAvailable, isEnabled, isOverridable, isUseEndNode, isUseRootNode, setAvailable, setLabel, setOverridable, setPropertySet, setSchematicDiagramClassNameByRef
 

Method Detail

isSelectNode

boolean isSelectNode()
                     throws IOException,
                            AutomationException
Indicates if the schematic nodes that belong to the Find Path trace result must be selected.

Product Availability

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

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

setSelectNode

void setSelectNode(boolean selectNode)
                   throws IOException,
                          AutomationException
Indicates if the schematic nodes that belong to the Find Path trace result must be selected.

Product Availability

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

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

isSelectLink

boolean isSelectLink()
                     throws IOException,
                            AutomationException
Indicates if the schematic links that belong to the Find Path trace result must be selected.

Product Availability

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

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

setSelectLink

void setSelectLink(boolean selectLink)
                   throws IOException,
                          AutomationException
Indicates if the schematic links that belong to the Find Path trace result must be selected.

Product Availability

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

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

getUserDataNameOfForbiddenLinks

String getUserDataNameOfForbiddenLinks()
                                       throws IOException,
                                              AutomationException
Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.

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.

setUserDataNameOfForbiddenLinks

void setUserDataNameOfForbiddenLinks(String name)
                                     throws IOException,
                                            AutomationException
Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.

Product Availability

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

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

getUserDataNameForLinkWeight

String getUserDataNameForLinkWeight()
                                    throws IOException,
                                           AutomationException
Name of the userdata that defines the links weight.

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.

setUserDataNameForLinkWeight

void setUserDataNameForLinkWeight(String name)
                                  throws IOException,
                                         AutomationException
Name of the userdata that defines the links weight.

Product Availability

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

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