|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.schematic.SchematicAnalystFindPath
public class SchematicAnalystFindPath
Find Path schematic trace analyst object.
Constructor Summary | |
---|---|
SchematicAnalystFindPath()
Constructs a SchematicAnalystFindPath using ArcGIS Engine. |
|
SchematicAnalystFindPath(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SchematicAnalystFindPath theSchematicAnalystFindPath = (SchematicAnalystFindPath) obj; |
Method Summary | |
---|---|
void |
clearResult()
Release internal results of the previous trace. |
boolean |
equals(Object o)
Compare this object with another |
void |
execute(ISchematicLayer schematicLayer,
ITrackCancel cancelTracker)
Execute the schematic algorithm. |
String |
getAlgorithmCLSID()
The CLSID of the algorithm. |
static String |
getClsid()
getClsid. |
String |
getLabel()
The label of the algorithm. |
IPropertySet |
getPropertySet()
The property set of the algorithm contains a collection of its parameters and their values. |
ISchematicDiagramClassName |
getSchematicDiagramClassName()
The diagram class object used to initialize the algorithm. |
IEnumSchematicFeature |
getTraceResult()
The set of schematic features detected by the trace operation. |
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. |
int |
hashCode()
the hashcode for this object |
boolean |
isAvailable()
Indicates if the algorithm is currently available. |
boolean |
isEnabled(ISchematicLayer schematicLayer)
Indicates if the algorithm is currently enabled. |
boolean |
isOverridable()
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap. |
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. |
boolean |
isUseEndNode()
Indicates if the algorithm use end nodes. |
boolean |
isUseRootNode()
Indicates if the algorithm use root nodes. |
void |
setAvailable(boolean available)
Indicates if the algorithm is currently available. |
void |
setLabel(String label)
The label of the algorithm. |
void |
setOverridable(boolean pOverridable)
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap. |
void |
setPropertySet(IPropertySet propertySet)
The property set of the algorithm contains a collection of its parameters and their values. |
void |
setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
The diagram class object used to initialize the algorithm. |
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 class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public SchematicAnalystFindPath() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic SchematicAnalystFindPath(Object obj) throws IOException
SchematicAnalystFindPath theSchematicAnalystFindPath = (SchematicAnalystFindPath) obj;
obj
to SchematicAnalystFindPath
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public IEnumSchematicFeature getTraceResult() throws IOException, AutomationException
getTraceResult
in interface ISchematicAnalystTraceResult
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearResult() throws IOException, AutomationException
clearResult
in interface ISchematicAnalystTraceResult
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEnabled(ISchematicLayer schematicLayer) throws IOException, AutomationException
isEnabled
in interface ISchematicAlgorithm
schematicLayer
- A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAvailable() throws IOException, AutomationException
isAvailable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAvailable(boolean available) throws IOException, AutomationException
setAvailable
in interface ISchematicAlgorithm
available
- The available (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isOverridable() throws IOException, AutomationException
isOverridable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOverridable(boolean pOverridable) throws IOException, AutomationException
setOverridable
in interface ISchematicAlgorithm
pOverridable
- The pOverridable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISchematicDiagramClassName getSchematicDiagramClassName() throws IOException, AutomationException
getSchematicDiagramClassName
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) throws IOException, AutomationException
setSchematicDiagramClassNameByRef
in interface ISchematicAlgorithm
schematicDiagramClassName
- A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLabel() throws IOException, AutomationException
getLabel
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabel(String label) throws IOException, AutomationException
setLabel
in interface ISchematicAlgorithm
label
- The label (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseRootNode() throws IOException, AutomationException
isUseRootNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseEndNode() throws IOException, AutomationException
isUseEndNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
getPropertySet
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPropertySet(IPropertySet propertySet) throws IOException, AutomationException
setPropertySet
in interface ISchematicAlgorithm
propertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAlgorithmCLSID() throws IOException, AutomationException
getAlgorithmCLSID
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker) throws IOException, AutomationException
execute
in interface ISchematicAlgorithm
schematicLayer
- A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSelectNode() throws IOException, AutomationException
isSelectNode
in interface ISchematicAnalystFindPath
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectNode(boolean selectNode) throws IOException, AutomationException
setSelectNode
in interface ISchematicAnalystFindPath
selectNode
- The selectNode (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSelectLink() throws IOException, AutomationException
isSelectLink
in interface ISchematicAnalystFindPath
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectLink(boolean selectLink) throws IOException, AutomationException
setSelectLink
in interface ISchematicAnalystFindPath
selectLink
- The selectLink (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getUserDataNameOfForbiddenLinks() throws IOException, AutomationException
getUserDataNameOfForbiddenLinks
in interface ISchematicAnalystFindPath
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUserDataNameOfForbiddenLinks(String name) throws IOException, AutomationException
setUserDataNameOfForbiddenLinks
in interface ISchematicAnalystFindPath
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getUserDataNameForLinkWeight() throws IOException, AutomationException
getUserDataNameForLinkWeight
in interface ISchematicAnalystFindPath
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUserDataNameForLinkWeight(String name) throws IOException, AutomationException
setUserDataNameForLinkWeight
in interface ISchematicAnalystFindPath
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |