com.esri.arcgis.schematic
Interface ISchematicAlgoSeparateOverlappingLinks

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoSeparateOverlappingLinks

public interface ISchematicAlgoSeparateOverlappingLinks
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Separate Overlapping Links schematic algorithm.

Description

The Separate Overlapping Links algorithm detects the links that are overlapping in the active schematic diagram and separate them. If links are currently selected in the active schematic diagram, the command only applies to the selected links.
Two links are said to be overlapping when they are connected to the same origin and extremity nodes, have the same number of link points and all those link points overlap.

Product Availability

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

See Also:

ISchematicAnalystFindOverlappingLinks

Method Summary

double	getBreakPointDistance() Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.
double	getShiftBetweenLinks() Distance between the links that are overlapping so that they are separated.
double	getStep() Threshold value beyond which two link points are said to be non overlapping.
boolean	isAbsoluteParameters() Indicates if the values set for the distance parameters must be interpreted as absolute units.
boolean	isUseOriginLinks() Indicates if the algorithm only processes the links parallel to the selected one.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the distance parameters must be interpreted as absolute units.
void	setBreakPointDistance(double pVal) Distance between the extremity nodes of the links and the break points that will be inserted on the links that are overlapping.
void	setShiftBetweenLinks(double pVal) Distance between the links that are overlapping so that they are separated.
void	setStep(double pVal) Threshold value beyond which two link points are said to be non overlapping.
void	setUseOriginLinks(boolean pVal) Indicates if the algorithm only processes the links parallel to the selected one.

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

getBreakPointDistance

double getBreakPointDistance()
                             throws IOException,
                                    AutomationException

Distance between the extremity nodes 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.

See Also:

ISchematicAlgoSeparateOverlappingLinks.getShiftBetweenLinks()

setBreakPointDistance

void setBreakPointDistance(double pVal)
                           throws IOException,
                                  AutomationException

Distance between the extremity nodes 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.

getShiftBetweenLinks

double getShiftBetweenLinks()
                            throws IOException,
                                   AutomationException

Distance between the links 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.

See Also:

ISchematicAlgoSeparateOverlappingLinks.getBreakPointDistance()

setShiftBetweenLinks

void setShiftBetweenLinks(double pVal)
                          throws IOException,
                                 AutomationException

Distance between the links 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.

getStep

double getStep()
               throws IOException,
                      AutomationException

Threshold value beyond which two link points are said to be non 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.

setStep

void setStep(double pVal)
             throws IOException,
                    AutomationException

Threshold value beyond which two link points are said to be non 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.

isAbsoluteParameters

boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

Description

If this parameter is false, the distance parameters are interpreted as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; that is, for instance, if the ShiftBetweenLinks property value is 2, the distance that will separate two links that were overlapping will correspond to the average size of two symbols placed side by side

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.

setAbsoluteParameters

void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

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.

isUseOriginLinks

boolean isUseOriginLinks()
                         throws IOException,
                                AutomationException

Indicates if the algorithm only processes the links parallel to the selected one. Only one link should be selected.

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.

setUseOriginLinks

void setUseOriginLinks(boolean pVal)
                       throws IOException,
                              AutomationException

Indicates if the algorithm only processes the links parallel to the selected one. Only one link should be selected.

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.