com.esri.arcgis.schematic
Class SchematicAlgoPartialOverlappingLinks

java.lang.Object
  com.esri.arcgis.schematic.SchematicAlgoPartialOverlappingLinks

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoPartialOverlappingLinks, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo, Serializable

public class SchematicAlgoPartialOverlappingLinks
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoPartialOverlappingLinks, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo

Partial Overlapping Links schematic algorithm object.

Description

This object is new at ArcGIS 9.3.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoPartialOverlappingLinks()
Constructs a SchematicAlgoPartialOverlappingLinks using ArcGIS Engine.

SchematicAlgoPartialOverlappingLinks(Object obj)
Construct a SchematicAlgoPartialOverlappingLinks using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
void	execute(INgView view, INgCancelTracker tracker) Executes the schematic algorithm.
String	getAlgorithmCLSID() CLSID of the schematic algorithm.
double	getAttractNodeLinkFactor() Parameter value used to quickly decrease the graphic link displacement between link and node when they are connected together.
double	getAttractNodesFactor() Parameter value used to quickly decrease the graphic nodes displacement between a node and its original position.
double	getBufferWidth() BufferZone width will be used to find links that overlap.
static String	getClsid() getClsid.
double	getGapDistance() Distance between the partial links that are overlapping so that they are separated.
String	getLabel() Label for the schematic algorithm that displays in the Layout Task dropdown list.
int	getNumberOfIterations() Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
INgNames	getParameterNames() List of the names for the schematic algorithm parameters.
Object	getParameterValue(String name) List of the values for the schematic algorithm parameters.
INgProject	getProject() Project the schematic algorithm is related to.
double	getRepelLinksFactor() Parameter value used to quickly increase the graphic links displacement for links that are very close.
double	getRepelNodeLinkFactor() Parameter value used to quickly increase the graphic link displacement between link and node when they are not connected together.
double	getRepelNodesFactor() Parameter value used to quickly increase the graphic nodes displacement for nodes that are very close.
int	hashCode() the hashcode for this object
void	initialize(INgProject wrk) Initializes the schematic algorithm for the specified project.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAvailable() Indicates if the schematic algorithm is available from the Layout Task dropdown list.
boolean	isEnabled(INgView view) Indicates if the schematic algorithm is enabled.
boolean	isGeneralizeResult() Indicates if resulting geometries are generalized.
boolean	isLeftRightHint() Indicates if relative left or right positions between links is kept as much as possible.
void	setAttractNodeLinkFactor(double dAttractNodeLinkFactor) Parameter value used to quickly decrease the graphic link displacement between link and node when they are connected together.
void	setAttractNodesFactor(double dAttractNodesFactor) Parameter value used to quickly decrease the graphic nodes displacement between a node and its original position.
void	setAvailable(boolean pVal) Indicates if the schematic algorithm is available from the Layout Task dropdown list.
void	setBufferWidth(double dBufferWidth) BufferZone width will be used to find links that overlap.
void	setGapDistance(double dGapDistance) Distance between the partial links that are overlapping so that they are separated.
void	setGeneralizeResult(boolean pVal) Indicates if resulting geometries are generalized.
void	setLabel(String pVal) Label for the schematic algorithm that displays in the Layout Task dropdown list.
void	setLeftRightHint(boolean pVal) Indicates if relative left or right positions between links is kept as much as possible.
void	setNumberOfIterations(int pVal) Number of Partial Overlapping Links schematic algorithm iterations executed before the final result is shown.
void	setParameterValue(String name, Object value) List of the values for the schematic algorithm parameters.
void	setRepelLinksFactor(double dRepelLinksFactor) Parameter value used to quickly increase the graphic links displacement for links that are very close.
void	setRepelNodeLinkFactor(double dRepelNodeLinkFactor) Parameter value used to quickly increase the graphic link displacement between link and node when they are not connected together.
void	setRepelNodesFactor(double dRepelNodesFactor) Parameter value used to quickly increase the graphic nodes displacement for nodes that are very close.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicAlgoPartialOverlappingLinks

public SchematicAlgoPartialOverlappingLinks()
                                     throws IOException,
                                            UnknownHostException

Constructs a SchematicAlgoPartialOverlappingLinks using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoPartialOverlappingLinks

public SchematicAlgoPartialOverlappingLinks(Object obj)
                                     throws IOException

Construct a SchematicAlgoPartialOverlappingLinks using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicAlgoPartialOverlappingLinks.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SchematicAlgoPartialOverlappingLinks theSchematicAlgoPartialOverlappingLinks = (SchematicAlgoPartialOverlappingLinks) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setBufferWidth

public void setBufferWidth(double dBufferWidth)
                    throws IOException,
                           AutomationException

BufferZone width will be used to find links that overlap.

Product Availability

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

Specified by:

setBufferWidth in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dBufferWidth - The dBufferWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferWidth

public double getBufferWidth()
                      throws IOException,
                             AutomationException

BufferZone width will be used to find links that overlap.

Product Availability

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

Specified by:

getBufferWidth in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dBufferWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGapDistance

public void setGapDistance(double dGapDistance)
                    throws IOException,
                           AutomationException

Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Specified by:

setGapDistance in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dGapDistance - The dGapDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGapDistance

public double getGapDistance()
                      throws IOException,
                             AutomationException

Distance between the partial links that are overlapping so that they are separated.

Product Availability

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

Specified by:

getGapDistance in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dGapDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepelNodesFactor

public void setRepelNodesFactor(double dRepelNodesFactor)
                         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:

setRepelNodesFactor in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dRepelNodesFactor - The dRepelNodesFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepelNodesFactor

public double getRepelNodesFactor()
                           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:

getRepelNodesFactor in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dRepelNodesFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepelLinksFactor

public void setRepelLinksFactor(double dRepelLinksFactor)
                         throws IOException,
                                AutomationException

Parameter value used to quickly increase the graphic links displacement for links that are very close.

Product Availability

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

Specified by:

setRepelLinksFactor in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dRepelLinksFactor - The dRepelLinksFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepelLinksFactor

public double getRepelLinksFactor()
                           throws IOException,
                                  AutomationException

Parameter value used to quickly increase the graphic links displacement for links that are very close.

Product Availability

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

Specified by:

getRepelLinksFactor in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dRepelLinksFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepelNodeLinkFactor

public void setRepelNodeLinkFactor(double dRepelNodeLinkFactor)
                            throws IOException,
                                   AutomationException

Parameter value used to quickly increase the graphic link displacement between link and node when they are not connected together.

Product Availability

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

Specified by:

setRepelNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dRepelNodeLinkFactor - The dRepelNodeLinkFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepelNodeLinkFactor

public double getRepelNodeLinkFactor()
                              throws IOException,
                                     AutomationException

Parameter value used to quickly increase the graphic link displacement between link and node when they are not connected together.

Product Availability

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

Specified by:

getRepelNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dRepelNodeLinkFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttractNodeLinkFactor

public void setAttractNodeLinkFactor(double dAttractNodeLinkFactor)
                              throws IOException,
                                     AutomationException

Parameter value used to quickly decrease the graphic link displacement between link and node when they are connected together.

Product Availability

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

Specified by:

setAttractNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dAttractNodeLinkFactor - The dAttractNodeLinkFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttractNodeLinkFactor

public double getAttractNodeLinkFactor()
                                throws IOException,
                                       AutomationException

Parameter value used to quickly decrease the graphic link displacement between link and node when they are connected together.

Product Availability

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

Specified by:

getAttractNodeLinkFactor in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dAttractNodeLinkFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttractNodesFactor

public void setAttractNodesFactor(double dAttractNodesFactor)
                           throws IOException,
                                  AutomationException

Parameter value used to quickly decrease the graphic nodes displacement between a node and its original position.

Product Availability

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

Specified by:

setAttractNodesFactor in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

dAttractNodesFactor - The dAttractNodesFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttractNodesFactor

public double getAttractNodesFactor()
                             throws IOException,
                                    AutomationException

Parameter value used to quickly decrease the graphic nodes displacement between a node and its original position.

Product Availability

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

Specified by:

getAttractNodesFactor in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The dAttractNodesFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

public int getNumberOfIterations()
                          throws IOException,
                                 AutomationException

Number of Partial Overlapping Links 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 ISchematicAlgoPartialOverlappingLinks

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 Partial Overlapping Links 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 ISchematicAlgoPartialOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLeftRightHint

public boolean isLeftRightHint()
                        throws IOException,
                               AutomationException

Indicates if relative left or right positions between links is kept as much as possible.

Product Availability

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

Specified by:

isLeftRightHint in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftRightHint

public void setLeftRightHint(boolean pVal)
                      throws IOException,
                             AutomationException

Indicates if relative left or right positions between links is kept as much as possible.

Product Availability

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

Specified by:

setLeftRightHint in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGeneralizeResult

public boolean isGeneralizeResult()
                           throws IOException,
                                  AutomationException

Indicates if resulting geometries are generalized.

Product Availability

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

Specified by:

isGeneralizeResult in interface ISchematicAlgoPartialOverlappingLinks

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeneralizeResult

public void setGeneralizeResult(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if resulting geometries are generalized.

Product Availability

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

Specified by:

setGeneralizeResult in interface ISchematicAlgoPartialOverlappingLinks

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(INgView view,
                    INgCancelTracker tracker)
             throws IOException,
                    AutomationException

Executes the schematic algorithm.

Product Availability

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

Specified by:

execute in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

tracker - A reference to a com.esri.arcgis.schematic.INgCancelTracker (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(INgView view)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is enabled. That is, if the Apply button is available.

Product Availability

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

Specified by:

isEnabled in interface ISchematicAlgorithm

Parameters:

view - A reference to a com.esri.arcgis.schematic.INgView (in, optional, pass 0 if not required)

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException

Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:

isAvailable in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean pVal)
                  throws IOException,
                         AutomationException

Indicates if the schematic algorithm is available from the Layout Task dropdown list.

Product Availability

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

Specified by:

setAvailable in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:

getLabel in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String pVal)
              throws IOException,
                     AutomationException

Label for the schematic algorithm that displays in the Layout Task dropdown list.

Product Availability

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

Specified by:

setLabel in interface ISchematicAlgorithm

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(INgProject wrk)
                throws IOException,
                       AutomationException

Initializes the schematic algorithm for the specified project.

Product Availability

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

Specified by:

initialize in interface ISchematicAlgorithm

Parameters:

wrk - A reference to a com.esri.arcgis.schematic.INgProject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException

CLSID of the schematic algorithm.

Product Availability

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

Specified by:

getAlgorithmCLSID in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException

Project the schematic algorithm is related to.

Product Availability

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

Specified by:

getProject in interface ISchematicAlgorithm

Returns:

A reference to a com.esri.arcgis.schematic.INgProject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterNames

public INgNames getParameterNames()
                           throws IOException,
                                  AutomationException

List of the names for the schematic algorithm parameters.

Product Availability

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

Specified by:

getParameterNames in interface ISchematicAlgorithmParameters

Returns:

A reference to a com.esri.arcgis.schematic.INgNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgorithmParameters.setParameterValue(String, java.lang.Object)

setParameterValue

public void setParameterValue(String name,
                              Object value)
                       throws IOException,
                              AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

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

Specified by:

setParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterValue

public Object getParameterValue(String name)
                         throws IOException,
                                AutomationException

List of the values for the schematic algorithm parameters.

Product Availability

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

Specified by:

getParameterValue in interface ISchematicAlgorithmParameters

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.