com.esri.arcgis.schematic
Interface ISchematicAlgoMainLineTree

All Superinterfaces:
ISchematicAlgorithm, java.io.Serializable
All Known Implementing Classes:
ISchematicAlgoMainLineTreeProxy, SchematicAlgoMainLineTree

public interface ISchematicAlgoMainLineTree
extends ISchematicAlgorithm, java.io.Serializable

COM Interface 'ISchematicAlgoMainLineTree'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that control the Main Line schematic algorithm.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDc5abcb89_f062_4723_8b71_cfcb8bfab8cf
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm
IIDbef20014_837c_4387_83ba_8523b7897a36
 
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
 

Field Detail

IIDc5abcb89_f062_4723_8b71_cfcb8bfab8cf

static final int IIDc5abcb89_f062_4723_8b71_cfcb8bfab8cf
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getDistanceAlongTheDirection

double getDistanceAlongTheDirection()
                                    throws java.io.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.

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

setDistanceAlongTheDirection

void setDistanceAlongTheDirection(double pVal)
                                  throws java.io.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.

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

getDistancePerpendicularToDirection

double getDistancePerpendicularToDirection()
                                           throws java.io.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.

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

setDistancePerpendicularToDirection

void setDistancePerpendicularToDirection(double pVal)
                                         throws java.io.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.

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

getBreakPoint

double getBreakPoint()
                     throws java.io.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.

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

setBreakPoint

void setBreakPoint(double pVal)
                   throws java.io.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.

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

getDirection

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

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

setDirection

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

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

getPageLayout

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

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

setPageLayout

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

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

isOrthogonalDisplay

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

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

setOrthogonalDisplay

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

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

isAbsoluteParameters

boolean isAbsoluteParameters()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

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

setAbsoluteParameters

void setAbsoluteParameters(boolean pVal)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the values set for the spacing parameters must be interpreted as absolute units.

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