com.esri.arcgis.schematic
Class SchematicAlgoSpatialDispatch

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAlgoSpatialDispatch
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgorithm, ISchematicAlgoSpatialDispatch, Serializable

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

Spatial Dispatch schematic algorithm object.

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)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoSpatialDispatch theSchematicAlgoSpatialDispatch = (SchematicAlgoSpatialDispatch) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker)
          Execute the schematic algorithm.
 String getAlgorithmCLSID()
          The CLSID of the algorithm.
 double getAttractionFactor()
          Factor used to quickly increase the schematic nodes displacement for nodes that are very close.
static String getClsid()
          getClsid.
 String getLabel()
          The label of the algorithm.
 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.
 IPropertySet getPropertySet()
          The property set of the algorithm contains a collection of its parameters and their values.
 ISchematicDiagramClassName getSchematicDiagramClassName()
          The diagram class object used to initialize the algorithm.
 int hashCode()
          the hashcode for this object
 boolean isAvailable()
          Indicates if the algorithm is currently available.
 boolean isEnabled(ISchematicLayer schematicLayer)
          Indicates if the algorithm is currently enabled.
 boolean isMoveNeighbours()
          Indicates if the Spatial Dispatch schematic algorithm can move the neighbour nodes of the currently selected nodes if needed.
 boolean isOverridable()
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 boolean isUseEndNode()
          Indicates if the algorithm use end nodes.
 boolean isUseRootNode()
          Indicates if the algorithm use root nodes.
 void setAttractionFactor(double pVal)
          Factor used to quickly increase the schematic nodes displacement for nodes that are very close.
 void setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setLabel(String label)
          The label of the algorithm.
 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 setOverridable(boolean pOverridable)
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 void setPropertySet(IPropertySet propertySet)
          The property set of the algorithm contains a collection of its parameters and their values.
 void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
          The diagram class object used to initialize the algorithm.
 
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
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoSpatialDispatch theSchematicAlgoSpatialDispatch = (SchematicAlgoSpatialDispatch) obj;

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

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently enabled.

Product Availability

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

Specified by:
isEnabled in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
Returns:
The enabled
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 algorithm is currently available.

Product Availability

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

Specified by:
isAvailable in interface ISchematicAlgorithm
Returns:
The available
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws IOException,
                         AutomationException
Indicates if the algorithm is currently available.

Product Availability

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

Specified by:
setAvailable in interface ISchematicAlgorithm
Parameters:
available - The available (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws IOException,
                             AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
isOverridable in interface ISchematicAlgorithm
Returns:
The pOverridable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws IOException,
                           AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:
setOverridable in interface ISchematicAlgorithm
Parameters:
pOverridable - The pOverridable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws IOException,
                                                               AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
getSchematicDiagramClassName in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws IOException,
                                              AutomationException
The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:
setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm
Parameters:
schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
getLabel in interface ISchematicAlgorithm
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException
The label of the algorithm.

Product Availability

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

Specified by:
setLabel in interface ISchematicAlgorithm
Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws IOException,
                             AutomationException
Indicates if the algorithm use root nodes.

Product Availability

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

Specified by:
isUseRootNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseEndNode

public boolean isUseEndNode()
                     throws IOException,
                            AutomationException
Indicates if the algorithm use end nodes.

Product Availability

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

Specified by:
isUseEndNode in interface ISchematicAlgorithm
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
getPropertySet in interface ISchematicAlgorithm
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:
setPropertySet in interface ISchematicAlgorithm
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException
The CLSID of the algorithm.

Product Availability

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

Specified by:
getAlgorithmCLSID in interface ISchematicAlgorithm
Returns:
The bstrCLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws IOException,
                    AutomationException
Execute the schematic algorithm.

Product Availability

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

Specified by:
execute in interface ISchematicAlgorithm
Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.