com.esri.arcgis.schematic
Class ISchematicAlgoLinearDispatchProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.ISchematicAlgoLinearDispatchProxy

All Implemented Interfaces:

ISchematicAlgoLinearDispatch, Externalizable, Serializable

Direct Known Subclasses:

ISchematicAlgoLinearDispatch2Proxy

public class ISchematicAlgoLinearDispatchProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoLinearDispatch, Serializable

Provides access to members that control the Linear Dispatch schematic algorithm.

Description

The Linear Dispatch algorithm separates linearly nodes that are visually very close or near to overlapping in the active schematic diagram regarding 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 Spatial Dispatch algorithm that works without the links during its execution but works on all nodes independently to their degree, the Linear Dispatch works with the links connected to the close nodes; it takes the degree of these nodes into account and depending on the algorithm properties, the link paths can be preserved. Only the nodes with degree 2 (that is; the nodes with two incident links) are moved. The nodes with degree 1 (that is; the nodes with only one incident link) could be also taken into account during the process when the MoveNodeDeg1 property is TRUE.

Product Availability

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

See Also:

ISchematicAlgoSpatialDispatch, Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	ISchematicAlgoLinearDispatchProxy()
	ISchematicAlgoLinearDispatchProxy(Object obj)
protected	ISchematicAlgoLinearDispatchProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getAttractionFactor() Factor used to quickly increase the graphic 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.
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	isWorkOnUnvisibleObjects() Indicates if the Linear Dispatch algorithm must work both with the visible and invisible graphic elements.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
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 graphic 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.
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	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Linear Dispatch algorithm must work both with the visible and invisible graphic elements.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ISchematicAlgoLinearDispatchProxy

public ISchematicAlgoLinearDispatchProxy()

ISchematicAlgoLinearDispatchProxy

public ISchematicAlgoLinearDispatchProxy(Object obj)
                                  throws IOException

Throws:

IOException

ISchematicAlgoLinearDispatchProxy

protected ISchematicAlgoLinearDispatchProxy(Object obj,
                                            String iid)
                                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

isPathPreservation

public boolean isPathPreservation()
                           throws IOException,
                                  AutomationException

Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

Description

In this case, the initial intermediate points displayed on these links are preserved and new intermediate points are displayed at the moved node initial position.

Product Availability

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

Specified by:

isPathPreservation in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathPreservation

public void setPathPreservation(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

Product Availability

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

Specified by:

setPathPreservation in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMoveNodeDeg1

public boolean isMoveNodeDeg1()
                       throws IOException,
                              AutomationException

Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

Product Availability

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

Specified by:

isMoveNodeDeg1 in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3(), ISchematicAlgoLinearDispatch.getNodesMovements()

setMoveNodeDeg1

public void setMoveNodeDeg1(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

Product Availability

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

Specified by:

setMoveNodeDeg1 in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNotMoveNodeDeg3

public boolean isNotMoveNodeDeg3()
                          throws IOException,
                                 AutomationException

Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

Product Availability

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

Specified by:

isNotMoveNodeDeg3 in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isMoveNodeDeg1(), ISchematicAlgoLinearDispatch.getNodesMovements()

setNotMoveNodeDeg3

public void setNotMoveNodeDeg3(boolean pVal)
                        throws IOException,
                               AutomationException

Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

Product Availability

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

Specified by:

setNotMoveNodeDeg3 in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaveMaximalShift

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

Product Availability

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

Specified by:

getLeaveMaximalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaveMaximalShift

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

Product Availability

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

Specified by:

setLeaveMaximalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimalShift

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

Product Availability

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

Specified by:

getMinimalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.getMaximalShift()

setMinimalShift

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

Product Availability

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

Specified by:

setMinimalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximalShift

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

Product Availability

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

Specified by:

getMaximalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.getMinimalShift()

setMaximalShift

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

Product Availability

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

Specified by:

setMaximalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNodesMovements

public int getNodesMovements()
                      throws IOException,
                             AutomationException

Node placement option.

Product Availability

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

Specified by:

getNodesMovements in interface ISchematicAlgoLinearDispatch

Returns:

A com.esri.arcgis.schematic.esriSchematicMovementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isMoveNodeDeg1(), ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3()

setNodesMovements

public void setNodesMovements(int pVal)
                       throws IOException,
                              AutomationException

Node placement option.

Product Availability

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

Specified by:

setNodesMovements in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicMovementType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttractionFactor

public double getAttractionFactor()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

getAttractionFactor in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttractionFactor

public void setAttractionFactor(double pVal)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:

setAttractionFactor in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

public int getNumberOfIterations()
                          throws 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.

Product Availability

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

Specified by:

getNumberOfIterations in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberOfIterations

public void setNumberOfIterations(int pVal)
                           throws 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.

Product Availability

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

Specified by:

setNumberOfIterations in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkOnUnvisibleObjects

public boolean isWorkOnUnvisibleObjects()
                                 throws IOException,
                                        AutomationException

Indicates if the Linear Dispatch algorithm must work both with the visible and invisible graphic elements.

Product Availability

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

Specified by:

isWorkOnUnvisibleObjects in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkOnUnvisibleObjects

public void setWorkOnUnvisibleObjects(boolean pVal)
                               throws IOException,
                                      AutomationException

Indicates if the Linear Dispatch algorithm must work both with the visible and invisible graphic elements.

Product Availability

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

Specified by:

setWorkOnUnvisibleObjects in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the MaximalShift property value is 2, the distance that will separate the nodes with degree 2 from the nodes they connect to will be at most the average size of two symbols placed side by side.

Product Availability

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

Specified by:

isAbsoluteParameters in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException