com.esri.arcgis.schematic
Interface ISchematicAnalystFindConnected

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAnalystFindConnectedProxy, SchematicAnalystFindConnected

public interface ISchematicAnalystFindConnected
extends Serializable

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

Description

The Find Connected searches for the set of schematic elements connected to the node currently selected in the active schematic diagram and highlights these detected elements.

Product Availability

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

Method Summary

int	getFlowDirection() Type of flow direction.
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 Connected trace result must be selected.
boolean	isSelectNode() Indicates if the graphic nodes that belong to the Find Connected trace result must be selected.
boolean	isUseFlow() Indicates if the flow must be used to find the connected elements.
void	setFlowDirection(int pVal) Type of flow direction.
void	setSelectLink(boolean pVal) Indicates if the graphic links that belong to the Find Connected trace result must be selected.
void	setSelectNode(boolean pVal) Indicates if the graphic nodes that belong to the Find Connected trace result must be selected.
void	setUseFlow(boolean pVal) Indicates if the flow must be used to find the connected elements.
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 Connected 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.ISchematicAlgoFindConnected

setSelectNode

void setSelectNode(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic nodes that belong to the Find Connected 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 Connected 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.ISchematicAlgoFindConnected

setSelectLink

void setSelectLink(boolean pVal)
                   throws IOException,
                          AutomationException

Indicates if the graphic links that belong to the Find Connected 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:

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.

getFlowDirection

int getFlowDirection()
                     throws IOException,
                            AutomationException

Type of flow direction.

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.

setFlowDirection

void setFlowDirection(int pVal)
                      throws IOException,
                             AutomationException

Type of flow direction.

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.

isUseFlow

boolean isUseFlow()
                  throws IOException,
                         AutomationException

Indicates if the flow must be used to find the connected elements.

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.

setUseFlow

void setUseFlow(boolean pVal)
                throws IOException,
                       AutomationException

Indicates if the flow must be used to find the connected elements.

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.