com.esri.arcgis.schematic
Interface ISchematicAlgoAngleDirected

All Superinterfaces:
ISchematicAlgorithm, Serializable
All Known Implementing Classes:
SchematicAlgoAngleDirected

public interface ISchematicAlgoAngleDirected
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Angle Directed algorithm.

Description

The Angle Directed algorithm allows bringing progressively the diagram links contained in the active schematic diagram into specified alignment directions. For each diagram link, the algorithm considers its current direction, searches for the nearest direction among the specified directions and moves the link so that it approaches this direction. If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Product Availability

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


Method Summary
 int getNumberOfDirections()
          Number of directions the Angle Directed algorithm must work with.
 int getNumberOfIterations()
          Number of Angle Directed schematic algorithm iterations executed before the final result is shown.
 void setNumberOfDirections(int pVal)
          Number of directions the Angle Directed algorithm must work with.
 void setNumberOfIterations(int pVal)
          Number of Angle Directed schematic algorithm iterations executed before the final result is shown.
 
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

getNumberOfIterations

int getNumberOfIterations()
                          throws IOException,
                                 AutomationException
Number of Angle Directed schematic algorithm iterations executed before the final result is shown.

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.

setNumberOfIterations

void setNumberOfIterations(int pVal)
                           throws IOException,
                                  AutomationException
Number of Angle Directed schematic algorithm iterations executed before the final result is shown.

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.

getNumberOfDirections

int getNumberOfDirections()
                          throws IOException,
                                 AutomationException
Number of directions the Angle Directed algorithm must work with.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoNumberOfDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberOfDirections

void setNumberOfDirections(int pVal)
                           throws IOException,
                                  AutomationException
Number of directions the Angle Directed algorithm must work with.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.schematic.esriSchematicAlgoNumberOfDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.