com.esri.arcgis.schematic
Class SchematicAlgoLinearDispatch

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAlgoLinearDispatch
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoLinearDispatch, ISchematicAlgoLinearDispatch2, ISchematicAlgorithm, ISchematicAlgorithmParameters, ISupportErrorInfo, Serializable

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

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)
          Construct a SchematicAlgoLinearDispatch 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 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.
 int getNumberOfIterations()
          Number of Linear Dispatch algorithm iterations that will be 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 isAbsoluteParameters()
          Indicates if the values set for the distance parameters must be interpreted as absolute units.
 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 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 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 isWorkOnUnvisibleObjects()
          Indicates if the Linear Dispatch algorithm must work both with the visible and invisible graphic elements.
 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 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 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.
 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 setParameterValue(String name, Object value)
          List of the values for the schematic algorithm parameters.
 void setPathPreservation(boolean pVal)
          Indicates if the path for the incident links related to the moved nodes is preserved during the algorithm execution.
 void setTranslateLeaf(boolean pVal)
          Indicates if the leaf connected to the path must be moved.
 void setWorkOnUnvisibleObjects(boolean pVal)
          Indicates if the Linear 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

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
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 SchematicAlgoLinearDispatch theSchematicAlgoLinearDispatch = (SchematicAlgoLinearDispatch) 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

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.

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.

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

isWorkOnUnvisibleObjects

public boolean isWorkOnUnvisibleObjects()
                                 throws IOException,
                                        AutomationException
Indicates if the Linear 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 ISchematicAlgoLinearDispatch
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 Linear 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 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.

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