com.esri.arcgis.schematic
Class ISchematicAnalystFindPathProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.ISchematicAnalystFindPathProxy
All Implemented Interfaces:
ISchematicAnalystFindPath, Externalizable, Serializable

public class ISchematicAnalystFindPathProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAnalystFindPath, 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, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ISchematicAnalystFindPathProxy()
           
  ISchematicAnalystFindPathProxy(Object obj)
           
protected ISchematicAnalystFindPathProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ISchematicAnalystFindPathProxy

public ISchematicAnalystFindPathProxy()

ISchematicAnalystFindPathProxy

public ISchematicAnalystFindPathProxy(Object obj)
                               throws IOException
Throws:
IOException

ISchematicAnalystFindPathProxy

protected ISchematicAnalystFindPathProxy(Object obj,
                                         String iid)
                                  throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

isSelectNode

public 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.

Specified by:
isSelectNode in interface ISchematicAnalystFindPath
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

public 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.

Specified by:
setSelectNode in interface ISchematicAnalystFindPath
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectLink

public 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.

Specified by:
isSelectLink in interface ISchematicAnalystFindPath
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

public 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.

Specified by:
setSelectLink in interface ISchematicAnalystFindPath
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserDataNameOfForbiddenLinks

public 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.

Specified by:
getUserDataNameOfForbiddenLinks in interface ISchematicAnalystFindPath
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

public 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.

Specified by:
setUserDataNameOfForbiddenLinks in interface ISchematicAnalystFindPath
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserDataNameForLinkWeight

public 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.

Specified by:
getUserDataNameForLinkWeight in interface ISchematicAnalystFindPath
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

public 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.

Specified by:
setUserDataNameForLinkWeight in interface ISchematicAnalystFindPath
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException