com.esri.arcgis.schematic
Interface ISchematicAnalystFindPath

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAnalystFindPathProxy, SchematicAnalystFindPath

public interface ISchematicAnalystFindPath
extends Serializable

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

Description

The Find Path searches for the shortest path route between two selected nodes in the active schematic diagram and highlights this path route.

Product Availability

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

See Also:

ISchematicAnalystFindConnected

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 graphic links that belong to the Find Path trace result must be selected.
boolean	isSelectNode() Indicates if the graphic nodes that belong to the Find Path trace result must be selected.
void	setSelectLink(boolean pVal) Indicates if the graphic links that belong to the Find Path trace result must be selected.
void	setSelectNode(boolean pVal) Indicates if the graphic nodes that belong to the Find Path trace result must be selected.
void	setUserDataNameForLinkWeight(String pVal) Name of the userdata that defines the links weight.
void	setUserDataNameOfForbiddenLinks(String pVal) Name of the userdata that defines the forbidden links; that is, the links which prevent the detection from continuing beyond them.

Method Detail

isSelectNode

boolean isSelectNode()
                     throws IOException,
                            AutomationException

Indicates if the graphic 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 pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath

setSelectNode

void setSelectNode(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic nodes that belong to the Find Path trace result must be selected.

Product Availability

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

Parameters:

pVal - The pVal (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 graphic 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 pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath

setSelectLink

void setSelectLink(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic links that belong to the Find Path trace result must be selected.

Product Availability

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

Parameters:

pVal - The pVal (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 pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath, INgUserData

setUserDataNameOfForbiddenLinks

void setUserDataNameOfForbiddenLinks(String pVal)
                                     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:

pVal - The pVal (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 pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.ISchematicAlgoFindPath, INgUserData

setUserDataNameForLinkWeight

void setUserDataNameForLinkWeight(String pVal)
                                  throws IOException,
                                         AutomationException

Name of the userdata that defines the links weight.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.