com.esri.arcgis.schematic
Class SchematicAlgoLinearDispatch

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoLinearDispatch, ISchematicAlgorithm, Serializable

public class SchematicAlgoLinearDispatch
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoLinearDispatch, ISchematicAlgorithm

Linear Dispatch schematic algorithm object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoLinearDispatch()
Constructs a SchematicAlgoLinearDispatch using ArcGIS Engine.

SchematicAlgoLinearDispatch(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoLinearDispatch theSchematicAlgoLinearDispatch = (SchematicAlgoLinearDispatch) 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	getLeaveMaximalShift() Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.
double	getMaximalShift() Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
double	getMinimalShift() Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
int	getNodesMovements() Node placement option for the layout.
int	getNumberOfIterations() Number of Linear Dispatch algorithm iterations that will be 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	isAbsoluteParameters() Indicates if the values set for the distance parameters must be interpreted as absolute units.
boolean	isAvailable() Indicates if the algorithm is currently available.
boolean	isEnabled(ISchematicLayer schematicLayer) Indicates if the algorithm is currently enabled.
boolean	isMoveNodeDeg1() Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.
boolean	isNotMoveNodeDeg3() Indicates if the nodes with degree 3 can not be moved during the algorithm execution.
boolean	isOverridable() Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
boolean	isPathPreservation() Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.
boolean	isTranslateLeaf() Indicates if the leaf connected to the path must be moved.
boolean	isUseEndNode() Indicates if the algorithm use end nodes.
boolean	isUseRootNode() Indicates if the algorithm use root nodes.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the distance parameters must be interpreted as absolute units.
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	setLeaveMaximalShift(double pVal) Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.
void	setMaximalShift(double pVal) Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
void	setMinimalShift(double pVal) Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution.
void	setMoveNodeDeg1(boolean pVal) Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.
void	setNodesMovements(int pVal) Node placement option for the layout.
void	setNotMoveNodeDeg3(boolean pVal) Indicates if the nodes with degree 3 can not be moved during the algorithm execution.
void	setNumberOfIterations(int pVal) Number of Linear Dispatch algorithm iterations that will be 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	setPathPreservation(boolean pVal) Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.
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.
void	setTranslateLeaf(boolean pVal) Indicates if the leaf connected to the path must be moved.

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

SchematicAlgoLinearDispatch

public SchematicAlgoLinearDispatch()
                            throws IOException,
                                   UnknownHostException

Constructs a SchematicAlgoLinearDispatch using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoLinearDispatch

public SchematicAlgoLinearDispatch(Object obj)
                            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicAlgoLinearDispatch theSchematicAlgoLinearDispatch = (SchematicAlgoLinearDispatch) obj;

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

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

isTranslateLeaf

public boolean isTranslateLeaf()
                        throws IOException,
                               AutomationException

Indicates if the leaf connected to the path must be moved.

Product Availability

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

Specified by:

isTranslateLeaf in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTranslateLeaf

public void setTranslateLeaf(boolean pVal)
                      throws IOException,
                             AutomationException

Indicates if the leaf connected to the path must be moved.

Product Availability

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

Specified by:

setTranslateLeaf in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPathPreservation

public boolean isPathPreservation()
                           throws IOException,
                                  AutomationException

Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

Description

In this case, the initial intermediate points displayed on these links are preserved and new intermediate points are displayed at the moved node initial position.

Product Availability

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

Specified by:

isPathPreservation in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathPreservation

public void setPathPreservation(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.

Product Availability

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

Specified by:

setPathPreservation in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMoveNodeDeg1

public boolean isMoveNodeDeg1()
                       throws IOException,
                              AutomationException

Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

Product Availability

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

Specified by:

isMoveNodeDeg1 in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3(), ISchematicAlgoLinearDispatch.getNodesMovements()

setMoveNodeDeg1

public void setMoveNodeDeg1(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the leave nodes (that is, the node with degree 1) can be moved during the algorithm execution.

Product Availability

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

Specified by:

setMoveNodeDeg1 in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNotMoveNodeDeg3

public boolean isNotMoveNodeDeg3()
                          throws IOException,
                                 AutomationException

Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

Product Availability

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

Specified by:

isNotMoveNodeDeg3 in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isMoveNodeDeg1(), ISchematicAlgoLinearDispatch.getNodesMovements()

setNotMoveNodeDeg3

public void setNotMoveNodeDeg3(boolean pVal)
                        throws IOException,
                               AutomationException

Indicates if the nodes with degree 3 can not be moved during the algorithm execution.

Product Availability

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

Specified by:

setNotMoveNodeDeg3 in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaveMaximalShift

public double getLeaveMaximalShift()
                            throws IOException,
                                   AutomationException

Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.

Product Availability

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

Specified by:

getLeaveMaximalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaveMaximalShift

public void setLeaveMaximalShift(double pVal)
                          throws IOException,
                                 AutomationException

Maximum distance the leave nodes must be spaced from the nodes that they connect when they are authorized to be moved during the algorithm execution.

Product Availability

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

Specified by:

setLeaveMaximalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimalShift

public double getMinimalShift()
                       throws IOException,
                              AutomationException

Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. Must be set only when the NodesMovement type is esriSchematicUserDefineDistance.

Product Availability

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

Specified by:

getMinimalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.getMaximalShift()

setMinimalShift

public void setMinimalShift(double pVal)
                     throws IOException,
                            AutomationException

Minimum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. Must be set only when the NodesMovement type is esriSchematicUserDefineDistance.

Product Availability

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

Specified by:

setMinimalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximalShift

public double getMaximalShift()
                       throws IOException,
                              AutomationException

Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. When this distance is reached, nodes are not moved anymore. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

Product Availability

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

Specified by:

getMaximalShift in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.getMinimalShift()

setMaximalShift

public void setMaximalShift(double pVal)
                     throws IOException,
                            AutomationException

Maximum distance the nodes with degree 2 must be spaced from their link extremity after the algorithm execution. When this distance is reached, nodes are not moved anymore. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

Product Availability

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

Specified by:

setMaximalShift in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNodesMovements

public int getNodesMovements()
                      throws IOException,
                             AutomationException

Node placement option for the layout.

Product Availability

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

Specified by:

getNodesMovements in interface ISchematicAlgoLinearDispatch

Returns:

A com.esri.arcgis.schematic.esriSchematicMovementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoLinearDispatch.isMoveNodeDeg1(), ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3()

setNodesMovements

public void setNodesMovements(int pVal)
                       throws IOException,
                              AutomationException

Node placement option for the layout.

Product Availability

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

Specified by:

setNodesMovements in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicMovementType constant (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.

Product Availability

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

Specified by:

getAttractionFactor in interface ISchematicAlgoLinearDispatch

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 ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberOfIterations

public int getNumberOfIterations()
                          throws IOException,
                                 AutomationException

Number of Linear Dispatch algorithm iterations that will be executed before the final result is shown. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

Product Availability

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

Specified by:

getNumberOfIterations in interface ISchematicAlgoLinearDispatch

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 Linear Dispatch algorithm iterations that will be executed before the final result is shown. Must be set only when the NodesMovement type is esriSchematicIterativeDistance.

Product Availability

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

Specified by:

setNumberOfIterations in interface ISchematicAlgoLinearDispatch

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

Description

When this property returns false, the parameters that define the distances are expressed as relative units to the average of the current symbols sizes used to represent the schematic nodes in the diagram; for instance, when the MaximalShift property value is 2, the distance that will separate the nodes with degree 2 from the nodes they connect to will be at most the average size of two symbols placed side by side.

Product Availability

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

Specified by:

isAbsoluteParameters in interface ISchematicAlgoLinearDispatch

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the distance parameters must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoLinearDispatch

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.