com.esri.arcgis.schematic
Interface ISchematicAlgoMainRing

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

public interface ISchematicAlgoMainRing
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Main Ring schematic algorithm.

Description

The Main Ring layout arranges the nodes and links in the active schematic diagram around the main ring and lays out hierarchically the nodes and links that connect to the detected main ring’s nodes. The main ring is the longest loop of the schematic diagram; that is, the loop formed by the most of links. 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
 double getBreakPoint()
          Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
 double getDistanceAlongTheDirection()
          Spacing between the nodes that display along the tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
 double getDistancePerpendicularToDirection()
          Spacing between the nodes that display perpendicularly to the tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
 double getHeight()
          Height of the main ring.
 double getLength()
          Width of the main ring.
 int getMainRingType()
          Main Ring form type.
 int getTreeType()
          Hierarchical trees layout type.
 boolean isAbsoluteParameters()
          Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
 boolean isLockLinks()
          Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the spacing and dimension parameters must be interpreted as absolute units.
 void setBreakPoint(double pVal)
          Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.
 void setDistanceAlongTheDirection(double pVal)
          Spacing between the nodes that display along the tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.
 void setDistancePerpendicularToDirection(double pVal)
          Spacing between the nodes that display perpendicularly to the tree direction; that is, spacing between the nodes that belong to a same hierarchical level.
 void setHeight(double pVal)
          Height of the main ring.
 void setLength(double pVal)
          Width of the main ring.
 void setLockLinks(boolean pVal)
          Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.
 void setMainRingType(int pVal)
          Main Ring form type.
 void setTreeType(int pVal)
          Hierarchical trees layout type.
 
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

isLockLinks

boolean isLockLinks()
                    throws IOException,
                           AutomationException
Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.

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.

setLockLinks

void setLockLinks(boolean pVal)
                  throws IOException,
                         AutomationException
Indicates if the links currently selected must be interprated as barriers that disable the Main Ring execution for a part of the diagram.

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.

getMainRingType

int getMainRingType()
                    throws IOException,
                           AutomationException
Main Ring form type.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoMainRingType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoMainRing.getTreeType()

setMainRingType

void setMainRingType(int pVal)
                     throws IOException,
                            AutomationException
Main Ring form type.

Product Availability

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

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

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws IOException,
                                           AutomationException
Spacing between the nodes that display along the tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

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:
ISchematicAlgoMainRing.getDistancePerpendicularToDirection()

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException
Spacing between the nodes that display along the tree direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level.

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.

getDistancePerpendicularToDirection

double getDistancePerpendicularToDirection()
                                           throws IOException,
                                                  AutomationException
Spacing between the nodes that display perpendicularly to the tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

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:
ISchematicAlgoMainRing.getDistanceAlongTheDirection()

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException
Spacing between the nodes that display perpendicularly to the tree direction; that is, spacing between the nodes that belong to a same hierarchical level.

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.

getHeight

double getHeight()
                 throws IOException,
                        AutomationException
Height of the main ring.

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:
ISchematicAlgoMainRing.getLength()

setHeight

void setHeight(double pVal)
               throws IOException,
                      AutomationException
Height of the main ring.

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.

getLength

double getLength()
                 throws IOException,
                        AutomationException
Width of the main ring.

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:
ISchematicAlgoMainRing.getHeight()

setLength

void setLength(double pVal)
               throws IOException,
                      AutomationException
Width of the main ring.

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 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

Description

With a break point value of 0, this last segment length is the longest and it displays with a right angle. With a break point value of 1, this last segment doesn’t exist; each link directly connects its two extremity nodes without intermediate point.

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 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the tree direction.

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.

getTreeType

int getTreeType()
                throws IOException,
                       AutomationException
Hierarchical trees layout type.

Description

This property value determines the layout of the trees coming out from the main ring’s nodes.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoHierarchicalType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicAlgoMainRing.getMainRingType()

setTreeType

void setTreeType(int pVal)
                 throws IOException,
                        AutomationException
Hierarchical trees layout type.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.schematic.esriSchematicAlgoHierarchicalType constant (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 spacing and dimension parameters must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the ring size and the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the main ring's width parameter value is 6, the main ring width corresponds to the average size of six 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 spacing and dimension 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.