com.esri.arcgis.schematic
Interface ISchematicAlgoLinearDispatch

All Superinterfaces:
ISchematicAlgorithm, java.io.Serializable
All Known Implementing Classes:
ISchematicAlgoLinearDispatchProxy, SchematicAlgoLinearDispatch

public interface ISchematicAlgoLinearDispatch
extends ISchematicAlgorithm, java.io.Serializable

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

Description: 'Provides access to members that control the Linear Dispatch 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 IIDa9f03517_9838_42c0_8941_6891d9a43d9e
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm
IIDbef20014_837c_4387_83ba_8523b7897a36
 
Method Summary
 double getAttractionFactor()
          Factor used to quickly increase the schematic nodes displacement for nodes that are very close.
 double getLeaveMaximalShift()
          Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.
 double getMaximalShift()
          Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
 double getMinimalShift()
          Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
 int getNodesMovements()
          Node placement option for the layout.
 int getNumberOfIterations()
          Number of Linear Dispatch algorithm iterations that will be executed before the final result is shown.
 boolean isAbsoluteParameters()
          Indicates if the values set for the distance parameters must be interpreted as absolute units.
 boolean isMoveNodeDeg1()
          Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.
 boolean isNotMoveNodeDeg3()
          Indicates if the nodes with degree 3 can not be moved during the algorithm execution.
 boolean isPathPreservation()
          Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.
 boolean isTranslateLeaf()
          Indicates if the leaf connected to the path must be moved.
 void setAbsoluteParameters(boolean pVal)
          Indicates if the values set for the distance parameters must be interpreted as absolute units.
 void setAttractionFactor(double pVal)
          Factor used to quickly increase the schematic nodes displacement for nodes that are very close.
 void setLeaveMaximalShift(double pVal)
          Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.
 void setMaximalShift(double pVal)
          Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
 void setMinimalShift(double pVal)
          Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
 void setMoveNodeDeg1(boolean pVal)
          Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.
 void setNodesMovements(int pVal)
          Node placement option for the layout.
 void setNotMoveNodeDeg3(boolean pVal)
          Indicates if the nodes with degree 3 can not be moved during the algorithm execution.
 void setNumberOfIterations(int pVal)
          Number of Linear Dispatch algorithm iterations that will be executed before the final result is shown.
 void setPathPreservation(boolean pVal)
          Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.
 void setTranslateLeaf(boolean pVal)
          Indicates if the leaf connected to the path must be moved.
 
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

IIDa9f03517_9838_42c0_8941_6891d9a43d9e

static final int IIDa9f03517_9838_42c0_8941_6891d9a43d9e
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

isTranslateLeaf

boolean isTranslateLeaf()
                        throws java.io.IOException,
                               AutomationException
Indicates if the leaf connected to the path must be moved.

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

setTranslateLeaf

void setTranslateLeaf(boolean pVal)
                      throws java.io.IOException,
                             AutomationException
Indicates if the leaf connected to the path must be moved.

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

isPathPreservation

boolean isPathPreservation()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

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

setPathPreservation

void setPathPreservation(boolean pVal)
                         throws java.io.IOException,
                                AutomationException
Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

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

isMoveNodeDeg1

boolean isMoveNodeDeg1()
                       throws java.io.IOException,
                              AutomationException
Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

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

setMoveNodeDeg1

void setMoveNodeDeg1(boolean pVal)
                     throws java.io.IOException,
                            AutomationException
Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

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

isNotMoveNodeDeg3

boolean isNotMoveNodeDeg3()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

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

setNotMoveNodeDeg3

void setNotMoveNodeDeg3(boolean pVal)
                        throws java.io.IOException,
                               AutomationException
Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

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

getLeaveMaximalShift

double getLeaveMaximalShift()
                            throws java.io.IOException,
                                   AutomationException
Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.

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

setLeaveMaximalShift

void setLeaveMaximalShift(double pVal)
                          throws java.io.IOException,
                                 AutomationException
Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.

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

getMinimalShift

double getMinimalShift()
                       throws java.io.IOException,
                              AutomationException
Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. Must be set only when the NodesMovement type is esriSchematicUserDefineDistance.

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

setMinimalShift

void setMinimalShift(double pVal)
                     throws java.io.IOException,
                            AutomationException
Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. Must be set only when the NodesMovement type is esriSchematicUserDefineDistance.

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

getMaximalShift

double getMaximalShift()
                       throws java.io.IOException,
                              AutomationException
Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. When this distance is reached, nodes are not moved anymore. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

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

setMaximalShift

void setMaximalShift(double pVal)
                     throws java.io.IOException,
                            AutomationException
Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. When this distance is reached, nodes are not moved anymore. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

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

getNodesMovements

int getNodesMovements()
                      throws java.io.IOException,
                             AutomationException
Node placement option for the layout.

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

setNodesMovements

void setNodesMovements(int pVal)
                       throws java.io.IOException,
                              AutomationException
Node placement option for the layout.

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

getAttractionFactor

double getAttractionFactor()
                           throws java.io.IOException,
                                  AutomationException
Factor used to quickly increase the schematic nodes displacement for nodes that are very close.

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

setAttractionFactor

void setAttractionFactor(double pVal)
                         throws java.io.IOException,
                                AutomationException
Factor used to quickly increase the schematic nodes displacement for nodes that are very close.

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

getNumberOfIterations

int getNumberOfIterations()
                          throws java.io.IOException,
                                 AutomationException
Number of Linear Dispatch algorithm iterations that will be executed before the final result is shown. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

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

setNumberOfIterations

void setNumberOfIterations(int pVal)
                           throws java.io.IOException,
                                  AutomationException
Number of Linear Dispatch algorithm iterations that will be executed before the final result is shown. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

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