|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.schematic.SchematicAlgoSpatialDispatch
public class SchematicAlgoSpatialDispatch
Spatial Dispatch schematic algorithm object.
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. |
IJSONArray |
getJSONParametersArray()
JSON parameters array. |
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 |
setJSONParametersObject(IJSONObject rhs1)
JSON parameters object. |
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 |
---|
public SchematicAlgoSpatialDispatch() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic SchematicAlgoSpatialDispatch(Object obj) throws IOException
SchematicAlgoSpatialDispatch theSchematicAlgoSpatialDispatch = (SchematicAlgoSpatialDispatch) obj;
obj
to SchematicAlgoSpatialDispatch
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int getNumberOfIterations() throws IOException, AutomationException
getNumberOfIterations
in interface ISchematicAlgoSpatialDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNumberOfIterations(int pVal) throws IOException, AutomationException
setNumberOfIterations
in interface ISchematicAlgoSpatialDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getAttractionFactor() throws IOException, AutomationException
getAttractionFactor
in interface ISchematicAlgoSpatialDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAttractionFactor(double pVal) throws IOException, AutomationException
setAttractionFactor
in interface ISchematicAlgoSpatialDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinShiftFactor() throws IOException, AutomationException
getMinShiftFactor
in interface ISchematicAlgoSpatialDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinShiftFactor(double pVal) throws IOException, AutomationException
setMinShiftFactor
in interface ISchematicAlgoSpatialDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaxShiftFactor() throws IOException, AutomationException
getMaxShiftFactor
in interface ISchematicAlgoSpatialDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaxShiftFactor(double pVal) throws IOException, AutomationException
setMaxShiftFactor
in interface ISchematicAlgoSpatialDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMoveNeighbours() throws IOException, AutomationException
isMoveNeighbours
in interface ISchematicAlgoSpatialDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMoveNeighbours(boolean pVal) throws IOException, AutomationException
setMoveNeighbours
in interface ISchematicAlgoSpatialDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEnabled(ISchematicLayer schematicLayer) throws IOException, AutomationException
isEnabled
in interface ISchematicAlgorithm
schematicLayer
- A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAvailable() throws IOException, AutomationException
isAvailable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAvailable(boolean available) throws IOException, AutomationException
setAvailable
in interface ISchematicAlgorithm
available
- The available (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isOverridable() throws IOException, AutomationException
isOverridable
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOverridable(boolean pOverridable) throws IOException, AutomationException
setOverridable
in interface ISchematicAlgorithm
pOverridable
- The pOverridable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISchematicDiagramClassName getSchematicDiagramClassName() throws IOException, AutomationException
getSchematicDiagramClassName
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) throws IOException, AutomationException
setSchematicDiagramClassNameByRef
in interface ISchematicAlgorithm
schematicDiagramClassName
- A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLabel() throws IOException, AutomationException
getLabel
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabel(String label) throws IOException, AutomationException
setLabel
in interface ISchematicAlgorithm
label
- The label (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseRootNode() throws IOException, AutomationException
isUseRootNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseEndNode() throws IOException, AutomationException
isUseEndNode
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
getPropertySet
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPropertySet(IPropertySet propertySet) throws IOException, AutomationException
setPropertySet
in interface ISchematicAlgorithm
propertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getAlgorithmCLSID() throws IOException, AutomationException
getAlgorithmCLSID
in interface ISchematicAlgorithm
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker) throws IOException, AutomationException
execute
in interface ISchematicAlgorithm
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IJSONArray getJSONParametersArray() throws IOException, AutomationException
getJSONParametersArray
in interface ISchematicJSONParameters
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setJSONParametersObject(IJSONObject rhs1) throws IOException, AutomationException
setJSONParametersObject
in interface ISchematicJSONParameters
rhs1
- A reference to a com.esri.arcgis.system.IJSONObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |