|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.schematic.SchematicAlgoLinearDispatch
public class SchematicAlgoLinearDispatch
Linear Dispatch schematic algorithm object.
| 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 |
|---|
public SchematicAlgoLinearDispatch()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public SchematicAlgoLinearDispatch(Object obj)
throws IOException
obj to SchematicAlgoLinearDispatch.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems
SchematicAlgoLinearDispatch theSchematicAlgoLinearDispatch = (SchematicAlgoLinearDispatch) obj;| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public boolean isPathPreservation()
throws IOException,
AutomationException
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.
isPathPreservation in interface ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPathPreservation(boolean pVal)
throws IOException,
AutomationException
setPathPreservation in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3(),
ISchematicAlgoLinearDispatch.getNodesMovements()
public void setMoveNodeDeg1(boolean pVal)
throws IOException,
AutomationException
setMoveNodeDeg1 in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgoLinearDispatch.isMoveNodeDeg1(),
ISchematicAlgoLinearDispatch.getNodesMovements()
public void setNotMoveNodeDeg3(boolean pVal)
throws IOException,
AutomationException
setNotMoveNodeDeg3 in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLeaveMaximalShift(double pVal)
throws IOException,
AutomationException
setLeaveMaximalShift in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgoLinearDispatch.getMaximalShift()
public void setMinimalShift(double pVal)
throws IOException,
AutomationException
setMinimalShift in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgoLinearDispatch.getMinimalShift()
public void setMaximalShift(double pVal)
throws IOException,
AutomationException
setMaximalShift in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgoLinearDispatch.isMoveNodeDeg1(),
ISchematicAlgoLinearDispatch.isNotMoveNodeDeg3()
public void setNodesMovements(int pVal)
throws IOException,
AutomationException
setNodesMovements in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAttractionFactor(double pVal)
throws IOException,
AutomationException
setAttractionFactor in interface ISchematicAlgoLinearDispatchpVal - 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 ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNumberOfIterations(int pVal)
throws IOException,
AutomationException
setNumberOfIterations in interface ISchematicAlgoLinearDispatchpVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isWorkOnUnvisibleObjects()
throws IOException,
AutomationException
isWorkOnUnvisibleObjects in interface ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWorkOnUnvisibleObjects(boolean pVal)
throws IOException,
AutomationException
setWorkOnUnvisibleObjects in interface ISchematicAlgoLinearDispatchpVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAbsoluteParameters()
throws IOException,
AutomationException
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.
isAbsoluteParameters in interface ISchematicAlgoLinearDispatchIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAbsoluteParameters(boolean pVal)
throws IOException,
AutomationException
setAbsoluteParameters in interface ISchematicAlgoLinearDispatchpVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isTranslateLeaf()
throws IOException,
AutomationException
isTranslateLeaf in interface ISchematicAlgoLinearDispatch2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTranslateLeaf(boolean pVal)
throws IOException,
AutomationException
setTranslateLeaf in interface ISchematicAlgoLinearDispatch2pVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void execute(INgView view,
INgCancelTracker tracker)
throws IOException,
AutomationException
execute in interface ISchematicAlgorithmview - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEnabled(INgView view)
throws IOException,
AutomationException
isEnabled in interface ISchematicAlgorithmview - A reference to a com.esri.arcgis.schematic.INgView (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 ISchematicAlgorithmIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAvailable(boolean pVal)
throws IOException,
AutomationException
setAvailable in interface ISchematicAlgorithmpVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getLabel()
throws IOException,
AutomationException
getLabel in interface ISchematicAlgorithmIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLabel(String pVal)
throws IOException,
AutomationException
setLabel in interface ISchematicAlgorithmpVal - The pVal (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void initialize(INgProject wrk)
throws IOException,
AutomationException
initialize in interface ISchematicAlgorithmwrk - A reference to a com.esri.arcgis.schematic.INgProject (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAlgorithmCLSID()
throws IOException,
AutomationException
getAlgorithmCLSID in interface ISchematicAlgorithmIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INgProject getProject()
throws IOException,
AutomationException
getProject in interface ISchematicAlgorithmIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INgNames getParameterNames()
throws IOException,
AutomationException
getParameterNames in interface ISchematicAlgorithmParametersIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ISchematicAlgorithmParameters.setParameterValue(String, java.lang.Object)
public void setParameterValue(String name,
Object value)
throws IOException,
AutomationException
setParameterValue in interface ISchematicAlgorithmParametersname - The name (in)value - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getParameterValue(String name)
throws IOException,
AutomationException
getParameterValue in interface ISchematicAlgorithmParametersname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (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 | ||||||||