com.esri.arcgis.schematic
Interface ISchematicAnalystFindConnected

All Superinterfaces:

ISchematicAlgorithm, ISchematicAnalystTraceResult, Serializable

All Known Implementing Classes:

SchematicAnalystFindConnected

public interface ISchematicAnalystFindConnected
extends ISchematicAnalystTraceResult, Serializable

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

Description

The Find Connected schematic analyst trace task returns all schematic features connected to a given schematic node in a schematic diagram. The trace task can take the flow direction into account or not, as specified.

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 schematic links that belong to the Find Connected trace result must be selected.
boolean	isSelectNode() Indicates if the schematic 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 flowDirection) Type of flow direction.
void	setSelectLink(boolean selectLink) Indicates if the schematic links that belong to the Find Connected trace result must be selected.
void	setSelectNode(boolean selectNode) Indicates if the schematic nodes that belong to the Find Connected trace result must be selected.
void	setUseFlow(boolean useFlow) Indicates if the flow must be used to find the connected elements.
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 Connected 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 Connected 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 Connected 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 Connected 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.

getFlowDirection

int getFlowDirection()
                     throws IOException,
                            AutomationException

Type of flow direction.

Product Availability

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

Returns:

The flowDirection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlowDirection

void setFlowDirection(int flowDirection)
                      throws IOException,
                             AutomationException

Type of flow direction.

Product Availability

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

Parameters:

flowDirection - The flowDirection (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 useFlow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFlow

void setUseFlow(boolean useFlow)
                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:

useFlow - The useFlow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.