com.esri.arcgis.schematic
Interface ISchematicAlgoCompression

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

public interface ISchematicAlgoCompression
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Compression schematic algorithm.

Product Availability

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


Method Summary
 double getClusterThresholdDistance()
          Threshold distance used to cluster connected nodes together.
 double getDistanceBetweenClusters()
          Minimum distance to preserve between connected clusters.
 boolean isAbsoluteParameters()
          Indicates if the values set for the spacings must be interpreted as absolute units.
 boolean isCompressTowardCenter()
          Indicates if the algorithm moves the nodes toward the diagram center.
 boolean isHeedContainers()
          Indicates if containers and their contents are processed as a whole or independently.
 boolean isKeepInsideVertices()
          Indicates if link vertices inside containers are kept or removed.
 boolean isKeepOutsideVertices()
          Indicates if the first link vertex outside a container is kept or removed.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the spacings must be interpreted as absolute units.
 void setClusterThresholdDistance(double pdThreshold)
          Threshold distance used to cluster connected nodes together.
 void setCompressTowardCenter(boolean pVal)
          Indicates if the algorithm moves the nodes toward the diagram center.
 void setDistanceBetweenClusters(double pdMinLength)
          Minimum distance to preserve between connected clusters.
 void setHeedContainers(boolean pVal)
          Indicates if containers and their contents are processed as a whole or independently.
 void setKeepInsideVertices(boolean pVal)
          Indicates if link vertices inside containers are kept or removed.
 void setKeepOutsideVertices(boolean pVal)
          Indicates if the first link vertex outside a container is kept or removed.
 
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

isHeedContainers

boolean isHeedContainers()
                         throws IOException,
                                AutomationException
Indicates if containers and their contents are processed as a whole or independently.

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.

setHeedContainers

void setHeedContainers(boolean pVal)
                       throws IOException,
                              AutomationException
Indicates if containers and their contents are processed as a whole or independently.

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.

isKeepInsideVertices

boolean isKeepInsideVertices()
                             throws IOException,
                                    AutomationException
Indicates if link vertices inside containers are kept or removed.

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.

setKeepInsideVertices

void setKeepInsideVertices(boolean pVal)
                           throws IOException,
                                  AutomationException
Indicates if link vertices inside containers are kept or removed.

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.

isKeepOutsideVertices

boolean isKeepOutsideVertices()
                              throws IOException,
                                     AutomationException
Indicates if the first link vertex outside a container is kept or removed.

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.

setKeepOutsideVertices

void setKeepOutsideVertices(boolean pVal)
                            throws IOException,
                                   AutomationException
Indicates if the first link vertex outside a container is kept or removed.

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.

getClusterThresholdDistance

double getClusterThresholdDistance()
                                   throws IOException,
                                          AutomationException
Threshold distance used to cluster connected nodes together.

Product Availability

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

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

setClusterThresholdDistance

void setClusterThresholdDistance(double pdThreshold)
                                 throws IOException,
                                        AutomationException
Threshold distance used to cluster connected nodes together.

Product Availability

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

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

getDistanceBetweenClusters

double getDistanceBetweenClusters()
                                  throws IOException,
                                         AutomationException
Minimum distance to preserve between connected clusters.

Product Availability

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

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

setDistanceBetweenClusters

void setDistanceBetweenClusters(double pdMinLength)
                                throws IOException,
                                       AutomationException
Minimum distance to preserve between connected clusters.

Product Availability

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

Parameters:
pdMinLength - The pdMinLength (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 spacings must be interpreted as absolute units.

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 spacings 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.

isCompressTowardCenter

boolean isCompressTowardCenter()
                               throws IOException,
                                      AutomationException
Indicates if the algorithm moves the nodes toward the diagram center.

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.

setCompressTowardCenter

void setCompressTowardCenter(boolean pVal)
                             throws IOException,
                                    AutomationException
Indicates if the algorithm moves the nodes toward the diagram center.

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.