com.esri.arcgis.schematic
Class SchematicAlgoSpatialDispatch

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

All Implemented Interfaces:

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

public class SchematicAlgoSpatialDispatch
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoSpatialDispatch, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo

Spatial Dispatch schematic algorithm class.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoSpatialDispatch()
Constructs a SchematicAlgoSpatialDispatch using ArcGIS Engine.

SchematicAlgoSpatialDispatch(Object obj)
Construct a SchematicAlgoSpatialDispatch 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	getAttractionFactor() Factor used to quickly increase the graphic nodes displacement for nodes that are very close.
static String	getClsid() getClsid.
String	getLabel() Label for the schematic algorithm that displays in the Layout Task dropdown list.
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.
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.
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	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	setAttractionFactor(double pVal) Factor used to quickly increase the graphic nodes displacement for nodes that are very close.
void	setAvailable(boolean pVal) Indicates if the schematic algorithm is available from the Layout Task dropdown list.
void	setLabel(String pVal) Label for the schematic algorithm that displays in the Layout Task dropdown list.
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	setParameterValue(String name, Object value) List of the values for the schematic algorithm parameters.
void	setWorkOnUnvisibleObjects(boolean pVal) Indicates if the Spatial Dispatch algorithm must work both with the visible and invisible graphic elements.

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

SchematicAlgoSpatialDispatch

public SchematicAlgoSpatialDispatch()
                             throws IOException,
                                    UnknownHostException

Constructs a SchematicAlgoSpatialDispatch using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoSpatialDispatch

public SchematicAlgoSpatialDispatch(Object obj)
                             throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SchematicAlgoSpatialDispatch theSchematicAlgoSpatialDispatch = (SchematicAlgoSpatialDispatch) 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

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.

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.