com.esri.arcgis.schematic
Interface ISchematicAlgoSpatialDispatch

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoSpatialDispatch

public interface ISchematicAlgoSpatialDispatch
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Spatial Dispatch schematic algorithm (named Separate Nodes algorithm in Schematics 2.3).

Description

The Spatial Dispatch algorithm separates nodes that are visually very close or near to overlapping in the active schematic diagram according to their current positions. If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Regarding to the Linear Dispatch algorithm which take links connected to the close nodes into account during the execution, the Spatial Dispatch algorithm moves the nodes independently on their degree and independently on the links they are connected to.

Product Availability

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

See Also:

ISchematicAlgoLinearDispatch

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

Method Detail

getNumberOfIterations

int getNumberOfIterations()
                          throws IOException,
                                 AutomationException

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

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.

setNumberOfIterations

void setNumberOfIterations(int pVal)
                           throws IOException,
                                  AutomationException

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

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.

getAttractionFactor

double getAttractionFactor()
                           throws IOException,
                                  AutomationException

Factor used to quickly increase the schematic nodes displacement for nodes that are very close.

Description

Bigger this factor is more the schematic nodes that are near to overlapping separate rapidly and very strongly.

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.

setAttractionFactor

void setAttractionFactor(double pVal)
                         throws IOException,
                                AutomationException

Factor used to quickly increase the schematic nodes displacement for nodes that are very close.

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.

getMinShiftFactor

double getMinShiftFactor()
                         throws 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.

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:

ISchematicAlgoSpatialDispatch.getMaxShiftFactor()

setMinShiftFactor

void setMinShiftFactor(double pVal)
                       throws 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.

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.

getMaxShiftFactor

double getMaxShiftFactor()
                         throws 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.

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:

ISchematicAlgoSpatialDispatch.getMinShiftFactor()

setMaxShiftFactor

void setMaxShiftFactor(double pVal)
                       throws 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.

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.

isMoveNeighbours

boolean isMoveNeighbours()
                         throws IOException,
                                AutomationException

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

Description

If a schematic selected set is currently defined in the active schematic diagram, the Spatial Dispatch works only on this schematic set. But, if the MoveNeighbours property is true, the neighbor of the selected nodes that are not currently selected could be moved during the algorithm execution.

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.

setMoveNeighbours

void setMoveNeighbours(boolean pVal)
                       throws IOException,
                              AutomationException

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

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.