|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.schematic.SchematicAlgoLinearDispatch
public class SchematicAlgoLinearDispatch
Linear Dispatch schematic algorithm object.
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. |
IJSONArray |
getJSONParametersArray()
JSON parameters array. |
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 |
setJSONParametersObject(IJSONObject rhs1)
JSON parameters object. |
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 |
---|
public SchematicAlgoLinearDispatch() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic SchematicAlgoLinearDispatch(Object obj) throws IOException
SchematicAlgoLinearDispatch theSchematicAlgoLinearDispatch = (SchematicAlgoLinearDispatch) obj;
obj
to SchematicAlgoLinearDispatch
.
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 boolean isTranslateLeaf() throws IOException, AutomationException
isTranslateLeaf
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTranslateLeaf(boolean pVal) throws IOException, AutomationException
setTranslateLeaf
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isPathPreservation() throws IOException, AutomationException
isPathPreservation
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPathPreservation(boolean pVal) throws IOException, AutomationException
setPathPreservation
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMoveNodeDeg1() throws IOException, AutomationException
isMoveNodeDeg1
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMoveNodeDeg1(boolean pVal) throws IOException, AutomationException
setMoveNodeDeg1
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isNotMoveNodeDeg3() throws IOException, AutomationException
isNotMoveNodeDeg3
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNotMoveNodeDeg3(boolean pVal) throws IOException, AutomationException
setNotMoveNodeDeg3
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLeaveMaximalShift() throws IOException, AutomationException
getLeaveMaximalShift
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLeaveMaximalShift(double pVal) throws IOException, AutomationException
setLeaveMaximalShift
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimalShift() throws IOException, AutomationException
getMinimalShift
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimalShift(double pVal) throws IOException, AutomationException
setMinimalShift
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximalShift() throws IOException, AutomationException
getMaximalShift
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximalShift(double pVal) throws IOException, AutomationException
setMaximalShift
in interface ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getNodesMovements() throws IOException, AutomationException
getNodesMovements
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNodesMovements(int pVal) throws IOException, AutomationException
setNodesMovements
in interface ISchematicAlgoLinearDispatch
pVal
- A com.esri.arcgis.schematic.esriSchematicMovementType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getAttractionFactor() throws IOException, AutomationException
getAttractionFactor
in interface ISchematicAlgoLinearDispatch
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 ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getNumberOfIterations() throws IOException, AutomationException
getNumberOfIterations
in interface ISchematicAlgoLinearDispatch
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 ISchematicAlgoLinearDispatch
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAbsoluteParameters() throws IOException, AutomationException
isAbsoluteParameters
in interface ISchematicAlgoLinearDispatch
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAbsoluteParameters(boolean pVal) throws IOException, AutomationException
setAbsoluteParameters
in interface ISchematicAlgoLinearDispatch
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 |