com.esri.arcgis.schematic
Interface ISchematicAlgoPartialOverlappingLinks

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

public interface ISchematicAlgoPartialOverlappingLinks
extends ISchematicAlgorithm, Serializable

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

Description

The Partial Overlapping Links algorithm detects and groups together the parts of link segments, close to each other, more or less parallel, and having more or less the same length. Each set of segments is then spread equally on both the left and right sides of the middle of the segment set.

Product Availability

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


Method Summary
 double getAttractNodeLinkFactor()
          Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.
 double getAttractNodesFactor()
          Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.
 double getBufferWidth()
          BufferZone width will be used to find links that overlap.
 double getGapDistance()
          Distance between the partial links that are overlapping so that they are separated.
 int getNumberOfIterations()
          Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
 double getRepelLinksFactor()
          Parameter value used to quickly increase the schematic links displacement for links that are very close.
 double getRepelNodeLinkFactor()
          Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.
 double getRepelNodesFactor()
          Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
 boolean isGeneralizeResult()
          Indicates if resulting geometries are generalized.
 boolean isLeftRightHint()
          Indicates if relative left or right positions between links is kept as much as possible.
 void setAttractNodeLinkFactor(double dAttractNodeLinkFactor)
          Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.
 void setAttractNodesFactor(double dAttractNodesFactor)
          Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.
 void setBufferWidth(double dBufferWidth)
          BufferZone width will be used to find links that overlap.
 void setGapDistance(double dGapDistance)
          Distance between the partial links that are overlapping so that they are separated.
 void setGeneralizeResult(boolean pVal)
          Indicates if resulting geometries are generalized.
 void setLeftRightHint(boolean pVal)
          Indicates if relative left or right positions between links is kept as much as possible.
 void setNumberOfIterations(int pVal)
          Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
 void setRepelLinksFactor(double dRepelLinksFactor)
          Parameter value used to quickly increase the schematic links displacement for links that are very close.
 void setRepelNodeLinkFactor(double dRepelNodeLinkFactor)
          Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.
 void setRepelNodesFactor(double dRepelNodesFactor)
          Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.
 
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

setBufferWidth

void setBufferWidth(double dBufferWidth)
                    throws IOException,
                           AutomationException
BufferZone width will be used to find links that overlap.

Product Availability

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

Parameters:
dBufferWidth - The dBufferWidth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferWidth

double getBufferWidth()
                      throws IOException,
                             AutomationException
BufferZone width will be used to find links that overlap.

Product Availability

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

Returns:
The dBufferWidth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGapDistance

void setGapDistance(double dGapDistance)
                    throws IOException,
                           AutomationException
Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Parameters:
dGapDistance - The dGapDistance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGapDistance

double getGapDistance()
                      throws IOException,
                             AutomationException
Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Returns:
The dGapDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelNodesFactor

void setRepelNodesFactor(double dRepelNodesFactor)
                         throws IOException,
                                AutomationException
Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Product Availability

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

Parameters:
dRepelNodesFactor - The dRepelNodesFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelNodesFactor

double getRepelNodesFactor()
                           throws IOException,
                                  AutomationException
Parameter value used to quickly increase the schematic nodes displacement for nodes that are very close.

Product Availability

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

Returns:
The dRepelNodesFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelLinksFactor

void setRepelLinksFactor(double dRepelLinksFactor)
                         throws IOException,
                                AutomationException
Parameter value used to quickly increase the schematic links displacement for links that are very close.

Product Availability

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

Parameters:
dRepelLinksFactor - The dRepelLinksFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelLinksFactor

double getRepelLinksFactor()
                           throws IOException,
                                  AutomationException
Parameter value used to quickly increase the schematic links displacement for links that are very close.

Product Availability

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

Returns:
The dRepelLinksFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRepelNodeLinkFactor

void setRepelNodeLinkFactor(double dRepelNodeLinkFactor)
                            throws IOException,
                                   AutomationException
Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.

Product Availability

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

Parameters:
dRepelNodeLinkFactor - The dRepelNodeLinkFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRepelNodeLinkFactor

double getRepelNodeLinkFactor()
                              throws IOException,
                                     AutomationException
Parameter value used to quickly increase the schematic link displacement between link and node when they are not connected together.

Product Availability

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

Returns:
The dRepelNodeLinkFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttractNodeLinkFactor

void setAttractNodeLinkFactor(double dAttractNodeLinkFactor)
                              throws IOException,
                                     AutomationException
Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.

Product Availability

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

Parameters:
dAttractNodeLinkFactor - The dAttractNodeLinkFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttractNodeLinkFactor

double getAttractNodeLinkFactor()
                                throws IOException,
                                       AutomationException
Parameter value used to quickly decrease the schematic link displacement between link and node when they are connected together.

Product Availability

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

Returns:
The dAttractNodeLinkFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttractNodesFactor

void setAttractNodesFactor(double dAttractNodesFactor)
                           throws IOException,
                                  AutomationException
Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.

Product Availability

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

Parameters:
dAttractNodesFactor - The dAttractNodesFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttractNodesFactor

double getAttractNodesFactor()
                             throws IOException,
                                    AutomationException
Parameter value used to quickly decrease the schematic nodes displacement between a node and its original position.

Product Availability

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

Returns:
The dAttractNodesFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

int getNumberOfIterations()
                          throws IOException,
                                 AutomationException
Number of Partial Overlapping 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 Partial Overlapping 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.

isLeftRightHint

boolean isLeftRightHint()
                        throws IOException,
                               AutomationException
Indicates if relative left or right positions between links is kept as much as possible.

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.

setLeftRightHint

void setLeftRightHint(boolean pVal)
                      throws IOException,
                             AutomationException
Indicates if relative left or right positions between links is kept as much as possible.

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.

isGeneralizeResult

boolean isGeneralizeResult()
                           throws IOException,
                                  AutomationException
Indicates if resulting geometries are generalized.

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.

setGeneralizeResult

void setGeneralizeResult(boolean pVal)
                         throws IOException,
                                AutomationException
Indicates if resulting geometries are generalized.

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.