com.esri.arcgis.schematic
Class ISchematicAlgoForceDirectedProxy

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

All Implemented Interfaces:

ISchematicAlgoForceDirected, Externalizable, Serializable

public class ISchematicAlgoForceDirectedProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicAlgoForceDirected, Serializable

Provides access to members that control the Force Directed schematic algorithm.

Description

The Force Directed algorithm uses a physical analogy to draw graphs by considering a graph as a force system where it tries to locally minimize the energy. It searches for an equilibrium state of the force system; that is a position for each node, such that the total forces on every node is zero. If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Product Availability

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

See Also:

ISchematicAlgoAngleDirected, Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getDegreeOfFreedom() Parameter value used to limit the area used to move the graphic nodes during each algorithm's iteration.
int	getNumberOfIterations() Number of Force Directed schematic algorithm iterations executed before the final result is shown.
double	getRepelFactor() Parameter value used to quickly increase the graphic nodes displacement for nodes that are very close.
boolean	isWithoutDegreeTwoNodes() Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.
boolean	isWorkOnUnvisibleObjects() Indicates if the Force Directed algorithm must work both with the visible and invisible graphic elements.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setDegreeOfFreedom(int pVal) Parameter value used to limit the area used to move the graphic nodes during each algorithm's iteration.
void	setNumberOfIterations(int pVal) Number of Force Directed schematic algorithm iterations executed before the final result is shown.
void	setRepelFactor(double pVal) Parameter value used to quickly increase the graphic nodes displacement for nodes that are very close.
void	setWithoutDegreeTwoNodes(boolean pVal) Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Force Directed 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

ISchematicAlgoForceDirectedProxy

public ISchematicAlgoForceDirectedProxy()

ISchematicAlgoForceDirectedProxy

public ISchematicAlgoForceDirectedProxy(Object obj)
                                 throws IOException

Throws:

IOException

ISchematicAlgoForceDirectedProxy

protected ISchematicAlgoForceDirectedProxy(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 Force Directed 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 ISchematicAlgoForceDirected

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 Force Directed 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 ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDegreeOfFreedom

public int getDegreeOfFreedom()
                       throws IOException,
                              AutomationException

Parameter value used to limit the area used to move the graphic nodes during each algorithm's iteration.

Description

Bigger this factor is more the area used to moves the node is large.

Product Availability

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

Specified by:

getDegreeOfFreedom in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDegreeOfFreedom

public void setDegreeOfFreedom(int pVal)
                        throws IOException,
                               AutomationException

Parameter value used to limit the area used to move the graphic nodes during each algorithm's iteration.

Product Availability

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

Specified by:

setDegreeOfFreedom in interface ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepelFactor

public double getRepelFactor()
                      throws IOException,
                             AutomationException

Parameter value 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:

getRepelFactor in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepelFactor

public void setRepelFactor(double pVal)
                    throws IOException,
                           AutomationException

Parameter value 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:

setRepelFactor in interface ISchematicAlgoForceDirected

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWithoutDegreeTwoNodes

public boolean isWithoutDegreeTwoNodes()
                                throws IOException,
                                       AutomationException

Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.

Product Availability

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

Specified by:

isWithoutDegreeTwoNodes in interface ISchematicAlgoForceDirected

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWithoutDegreeTwoNodes

public void setWithoutDegreeTwoNodes(boolean pVal)
                              throws IOException,
                                     AutomationException

Indicates if the nodes with degree 2 can be temporally out-of-the-way during the first phase of the algorithm execution so the computing time is decreased.

Product Availability

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

Specified by:

setWithoutDegreeTwoNodes in interface ISchematicAlgoForceDirected

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 Force Directed 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 ISchematicAlgoForceDirected

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 Force Directed 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 ISchematicAlgoForceDirected

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