com.esri.arcgis.schematic
Interface ISchematicAlgoSpatialDispatch

All Superinterfaces:

ISchematicAlgorithm, java.io.Serializable

All Known Implementing Classes:

ISchematicAlgoSpatialDispatchProxy, SchematicAlgoSpatialDispatch

public interface ISchematicAlgoSpatialDispatch
extends ISchematicAlgorithm, java.io.Serializable

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

Description: 'Provides access to members that control the Spatial Dispatch schematic algorithm (named Separate Nodes algorithm in Schematics 2.3).' 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	IIDd8a7f664_535e_459c_84f8_222fdc6fc3f8
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	getMaxShiftFactor() Maximum displacement between two moved nodes.
double	getMinShiftFactor() Minimum displacement between two moved nodes.
int	getNumberOfIterations() Number of Spatial Dispatch schematic algorithm iterations executed before the final result is shown.
boolean	isMoveNeighbours() Indicates if the Spatial Dispatch schematic algorithm can move the neighbour nodes of the currently selected nodes if needed.
void	setAttractionFactor(double pVal) Factor used to quickly increase the schematic nodes displacement for nodes that are very close.
void	setMaxShiftFactor(double pVal) Maximum displacement between two moved nodes.
void	setMinShiftFactor(double pVal) Minimum displacement between two moved nodes.
void	setMoveNeighbours(boolean pVal) Indicates if the Spatial Dispatch schematic algorithm can move the neighbour nodes of the currently selected nodes if needed.
void	setNumberOfIterations(int pVal) Number of Spatial Dispatch schematic algorithm iterations executed before the final result is shown.

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

IIDd8a7f664_535e_459c_84f8_222fdc6fc3f8

static final int IIDd8a7f664_535e_459c_84f8_222fdc6fc3f8

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

getNumberOfIterations

int getNumberOfIterations()
                          throws java.io.IOException,
                                 AutomationException

Number of Spatial Dispatch schematic algorithm iterations executed before the final result is shown.

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 Spatial Dispatch schematic algorithm iterations executed before the final result is shown.

Parameters:

pVal - The pVal (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.

getMinShiftFactor

double getMinShiftFactor()
                         throws java.io.IOException,
                                AutomationException

Minimum displacement between two moved nodes. Default value used by the algorithm, when the coefficient computed from the attraction factor value is lower than it.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinShiftFactor

void setMinShiftFactor(double pVal)
                       throws java.io.IOException,
                              AutomationException

Minimum displacement between two moved nodes. Default value used by the algorithm, when the coefficient computed from the attraction factor value is lower than it.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxShiftFactor

double getMaxShiftFactor()
                         throws java.io.IOException,
                                AutomationException

Maximum displacement between two moved nodes. Default value used by the algorithm, when the coefficient computed from the attraction factor value is upper than it.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxShiftFactor

void setMaxShiftFactor(double pVal)
                       throws java.io.IOException,
                              AutomationException

Maximum displacement between two moved nodes. Default value used by the algorithm, when the coefficient computed from the attraction factor value is upper than it.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMoveNeighbours

boolean isMoveNeighbours()
                         throws java.io.IOException,
                                AutomationException

Indicates if the Spatial Dispatch schematic algorithm can move the neighbour nodes of the currently selected nodes if needed.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMoveNeighbours

void setMoveNeighbours(boolean pVal)
                       throws java.io.IOException,
                              AutomationException

Indicates if the Spatial Dispatch schematic algorithm can move the neighbour nodes of the currently selected nodes if needed.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.