com.esri.arcgis.schematic
Interface ISchematicAlgoMainLineTree

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

public interface ISchematicAlgoMainLineTree
extends ISchematicAlgorithm, Serializable

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

Description

The Main Line Tree algorithm arranges the schematic nodes and links in a diagram hierarchically along a main line branch, which is centrally placed with its related branches positioned on either its left or right side or both. Root and end schematic nodes can be specified in the diagram so the algorithm works from a main line starting at the specified root node and ending at the specified end node.

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 main line.
 int getDirection()
          Main line tree direction.
 double getDistanceAlongTheDirection()
          Spacing between the nodes that display along the main line 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 main line direction; that is, spacing between the nodes that belong to a same hierarchical level.
 int getPageLayout()
          Main line tree layout type.
 boolean isAbsoluteParameters()
          Indicates if the values set for the spacing parameters must be interpreted as absolute units.
 boolean isOrthogonalDisplay()
          Indicates if the links must display with right angles.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the spacing 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 main line.
 void setDirection(int pVal)
          Main line tree direction.
 void setDistanceAlongTheDirection(double pVal)
          Spacing between the nodes that display along the main line 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 main line direction; that is, spacing between the nodes that belong to a same hierarchical level.
 void setOrthogonalDisplay(boolean pVal)
          Indicates if the links must display with right angles.
 void setPageLayout(int pVal)
          Main line tree 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

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws IOException,
                                           AutomationException
Spacing between the nodes that display along the main line 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.

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws IOException,
                                         AutomationException
Spacing between the nodes that display along the main line 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 main line 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.

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws IOException,
                                                AutomationException
Spacing between the nodes that display perpendicularly to the main line 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.

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 main line.

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 main line.

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.

getDirection

int getDirection()
                 throws IOException,
                        AutomationException
Main line tree direction.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int pVal)
                  throws IOException,
                         AutomationException
Main line tree direction.

Product Availability

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

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

getPageLayout

int getPageLayout()
                  throws IOException,
                         AutomationException
Main line tree layout type.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoMainLineType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPageLayout

void setPageLayout(int pVal)
                   throws IOException,
                          AutomationException
Main line tree layout type.

Product Availability

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

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

isOrthogonalDisplay

boolean isOrthogonalDisplay()
                            throws IOException,
                                   AutomationException
Indicates if the links must display with right angles.

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.

setOrthogonalDisplay

void setOrthogonalDisplay(boolean pVal)
                          throws IOException,
                                 AutomationException
Indicates if the links must display with right angles.

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 spacing parameters 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 spacing 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.