com.esri.arcgis.schematic
Interface ISchematicAlgorithm

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISchematicAlgorithmProxy, SchematicAlgoAngleDirected, SchematicAlgoCompactTree, SchematicAlgoComposite, SchematicAlgoForceDirected, SchematicAlgoGrid, SchematicAlgoHierarchical, SchematicAlgoInitialPositions, SchematicAlgoLabelPlacementOptimizer, SchematicAlgoLinearDispatch, SchematicAlgoMainLineTree, SchematicAlgoMainRing, SchematicAlgoMarkCrossings, SchematicAlgoOrthogonal, SchematicAlgoPartialOverlappingLinks, SchematicAlgoRadialTree, SchematicAlgoReduceVertices, SchematicAlgoRestoreSavedPositions, SchematicAlgoRotateNodesAlongLinks, SchematicAlgoRotateTree, SchematicAlgoSeparateOverlappingLinks, SchematicAlgoSmartTree, SchematicAlgoSpatialDispatch, SchematicAlgoSquareLinks, SchematicAnalystFindConnected, SchematicAnalystFindLoops, SchematicAnalystFindOverlappingLinks, SchematicAnalystFindPath, SchematicAutomaticScaling

public interface ISchematicAlgorithm
extends Serializable

Provides access to members that control the schematic algorithm.

Product Availability

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

See Also:
ISchematicAlgorithmSheet, ISchematicAlgorithmParameters, ISchematicAlgorithmPage

Method Summary
 void execute(INgView view, INgCancelTracker tracker)
          Executes the schematic algorithm.
 String getAlgorithmCLSID()
          CLSID of the schematic algorithm.
 String getLabel()
          Label for the schematic algorithm that displays in the Layout Task dropdown list.
 INgProject getProject()
          Project the schematic algorithm is related to.
 void initialize(INgProject wrk)
          Initializes the schematic algorithm for the specified project.
 boolean isAvailable()
          Indicates if the schematic algorithm is available from the Layout Task dropdown list.
 boolean isEnabled(INgView view)
          Indicates if the schematic algorithm is enabled.
 void setAvailable(boolean pVal)
          Indicates if the schematic algorithm is available from the Layout Task dropdown list.
 void setLabel(String pVal)
          Label for the schematic algorithm that displays in the Layout Task dropdown list.
 

Method Detail

execute

void execute(INgView view,
             INgCancelTracker tracker)
             throws IOException,
                    AutomationException
Executes the schematic algorithm.

Product Availability

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

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)
tracker - A reference to a com.esri.arcgis.schematic.INgCancelTracker (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled(INgView view)
                  throws IOException,
                         AutomationException
Indicates if the schematic algorithm is enabled. That is, if the Apply button is available.

Product Availability

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

Parameters:
view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvailable

boolean isAvailable()
                    throws IOException,
                           AutomationException
Indicates if the schematic algorithm is available from the Layout Task dropdown list.

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.

setAvailable

void setAvailable(boolean pVal)
                  throws IOException,
                         AutomationException
Indicates if the schematic algorithm is available from the Layout Task dropdown list.

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.

getLabel

String getLabel()
                throws IOException,
                       AutomationException
Label for the schematic algorithm that displays in the Layout Task dropdown list.

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.

setLabel

void setLabel(String pVal)
              throws IOException,
                     AutomationException
Label for the schematic algorithm that displays in the Layout Task dropdown list.

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.

initialize

void initialize(INgProject wrk)
                throws IOException,
                       AutomationException
Initializes the schematic algorithm for the specified project.

Product Availability

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

Parameters:
wrk - A reference to a com.esri.arcgis.schematic.INgProject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
CLSID of the schematic algorithm.

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.

getProject

INgProject getProject()
                      throws IOException,
                             AutomationException
Project the schematic algorithm is related to.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgProject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.