com.esri.arcgis.schematic
Interface ISchematicAlgoSquareLinks

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoSquareLinks

public interface ISchematicAlgoSquareLinks
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Square Links schematic algorithm.

Description

The Square Links algorithm computes and inserts intermediate points along links path routes so that these links path routes are displayed with right angles. If no link is selected in the active schematic diagram, the algorithm applies on all links in the diagram. If one or several links are selected in the diagram, the command only impacts these selected links.

Product Availability

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

See Also:

ISchematicAlgoOrthogonal

Method Summary

double	getBreakPoint() Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.
double	getDistanceBetweenLinks() Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.
int	getNumberOfIterations() Number of Square Links schematic algorithm iterations executed before the final result is shown.
boolean	isPreservePath() Indicates if the path of the schematic links must be preserved during the algorithm execution.
void	setBreakPoint(double pVal) Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.
void	setDistanceBetweenLinks(double pVal) Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.
void	setNumberOfIterations(int pVal) Number of Square Links schematic algorithm iterations executed before the final result is shown.
void	setPreservePath(boolean pVal) Indicates if the path of the schematic links must be preserved during the algorithm execution.

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 Square Links 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 Square Links 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.

isPreservePath

boolean isPreservePath()
                       throws IOException,
                              AutomationException

Indicates if the path of the schematic links must be preserved during the algorithm execution.

Description

If this PreservePath property is true, the intermediate points that will be inserted on the squared links will be computed according to the current intermediate points already existing along the links.

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.

setPreservePath

void setPreservePath(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the path of the schematic links must be preserved during the algorithm execution.

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.

getBreakPoint

double getBreakPoint()
                     throws IOException,
                            AutomationException

Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.

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.

setBreakPoint

void setBreakPoint(double pVal)
                   throws IOException,
                          AutomationException

Number comprised between 0 and 1 that allows computing the distance between the extremity node of the links and the break points that will be inserted on the links that are overlapping.

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.

getDistanceBetweenLinks

double getDistanceBetweenLinks()
                               throws IOException,
                                      AutomationException

Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.

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.

setDistanceBetweenLinks

void setDistanceBetweenLinks(double pVal)
                             throws IOException,
                                    AutomationException

Number comprised between 0 and 1 used to compute the distance between the links or the link segments that are overlapping so that they are separated.

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.