com.esri.arcgis.schematic
Class ISchematicAlgoSpatialDispatchProxy

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

All Implemented Interfaces:

ISchematicAlgoSpatialDispatch, Externalizable, Serializable

public class ISchematicAlgoSpatialDispatchProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoSpatialDispatch, 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, Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	ISchematicAlgoSpatialDispatchProxy()
	ISchematicAlgoSpatialDispatchProxy(Object obj)
protected	ISchematicAlgoSpatialDispatchProxy(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	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.
boolean	isWorkOnUnvisibleObjects() Indicates if the Spatial Dispatch algorithm must work both with the visible and invisible graphic elements.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setAttractionFactor(double pVal) Factor used to quickly increase the graphic 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.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Spatial 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

ISchematicAlgoSpatialDispatchProxy

public ISchematicAlgoSpatialDispatchProxy()

ISchematicAlgoSpatialDispatchProxy

public ISchematicAlgoSpatialDispatchProxy(Object obj)
                                   throws IOException

Throws:

IOException

ISchematicAlgoSpatialDispatchProxy

protected ISchematicAlgoSpatialDispatchProxy(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

getNumberOfIterations

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

Specified by:

getNumberOfIterations in interface ISchematicAlgoSpatialDispatch

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

Product Availability

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

Specified by:

setNumberOfIterations in interface ISchematicAlgoSpatialDispatch

Parameters:

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

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.

Specified by:

getAttractionFactor in interface ISchematicAlgoSpatialDispatch

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 ISchematicAlgoSpatialDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinShiftFactor

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

Specified by:

getMinShiftFactor in interface ISchematicAlgoSpatialDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSpatialDispatch.getMaxShiftFactor()

setMinShiftFactor

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

Specified by:

setMinShiftFactor in interface ISchematicAlgoSpatialDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxShiftFactor

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

Specified by:

getMaxShiftFactor in interface ISchematicAlgoSpatialDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoSpatialDispatch.getMinShiftFactor()

setMaxShiftFactor

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

Specified by:

setMaxShiftFactor in interface ISchematicAlgoSpatialDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMoveNeighbours

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

Specified by:

isMoveNeighbours in interface ISchematicAlgoSpatialDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMoveNeighbours

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

Specified by:

setMoveNeighbours in interface ISchematicAlgoSpatialDispatch

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 Spatial 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 ISchematicAlgoSpatialDispatch

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 Spatial 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 ISchematicAlgoSpatialDispatch

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