|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.schematic.SchematicAlgoMainLineTree
public class SchematicAlgoMainLineTree
Main Line Tree schematic algorithm object.
Constructor Summary | |
---|---|
SchematicAlgoMainLineTree()
Constructs a SchematicAlgoMainLineTree using ArcGIS Engine. |
|
SchematicAlgoMainLineTree(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SchematicAlgoMainLineTree theSchematicAlgoMainLineTree = (SchematicAlgoMainLineTree) 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 |
getBreakPoint()
Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the main line. |
static String |
getClsid()
getClsid. |
int |
getDirection()
Main line tree direction. |
double |
getDistanceAlongTheDirection()
Spacing between the nodes that display along the main line direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level. |
double |
getDistancePerpendicularToDirection()
Spacing between the nodes that display perpendicularly to the main line direction; that is, spacing between the nodes that belong to a same hierarchical level. |
String |
getLabel()
The label of the algorithm. |
int |
getPageLayout()
Main line tree layout type. |
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 spacing 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 |
isOrthogonalDisplay()
Indicates if the links must display with right angles. |
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 |
setAbsoluteParameters(boolean pVal)
Indicates if the values set for the spacing parameters must be interpreted as absolute units. |
void |
setAvailable(boolean available)
Indicates if the algorithm is currently available. |
void |
setBreakPoint(double pVal)
Number comprised between 0 and 1 to define the relative position of the break point on the last segment of the links; that is on the link segment that is paralleled to the main line. |
void |
setDirection(int pVal)
Main line tree direction. |
void |
setDistanceAlongTheDirection(double pVal)
Spacing between the nodes that display along the main line direction; that is, spacing between a node belonging to the (n) hierarchical level and a node belonging to the (n+1) hierarchical level. |
void |
setDistancePerpendicularToDirection(double pVal)
Spacing between the nodes that display perpendicularly to the main line direction; that is, spacing between the nodes that belong to a same hierarchical level. |
void |
setLabel(String label)
The label of the algorithm. |
void |
setOrthogonalDisplay(boolean pVal)
Indicates if the links must display with right angles. |
void |
setOverridable(boolean pOverridable)
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap. |
void |
setPageLayout(int pVal)
Main line tree layout type. |
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 SchematicAlgoMainLineTree() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic SchematicAlgoMainLineTree(Object obj) throws IOException
SchematicAlgoMainLineTree theSchematicAlgoMainLineTree = (SchematicAlgoMainLineTree) obj;
obj
to SchematicAlgoMainLineTree
.
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 double getDistanceAlongTheDirection() throws IOException, AutomationException
getDistanceAlongTheDirection
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.getDistancePerpendicularToDirection()
public void setDistanceAlongTheDirection(double pVal) throws IOException, AutomationException
setDistanceAlongTheDirection
in interface ISchematicAlgoMainLineTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getDistancePerpendicularToDirection() throws IOException, AutomationException
getDistancePerpendicularToDirection
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.getDistanceAlongTheDirection()
public void setDistancePerpendicularToDirection(double pVal) throws IOException, AutomationException
setDistancePerpendicularToDirection
in interface ISchematicAlgoMainLineTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getBreakPoint() throws IOException, AutomationException
With a break point value of 0, this segment length is the longest and it displays with a right angle. With a break point value of 1, this segment doesn’t exist; each link directly connects its two extremity nodes without intermediate point.
getBreakPoint
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.isOrthogonalDisplay()
public void setBreakPoint(double pVal) throws IOException, AutomationException
setBreakPoint
in interface ISchematicAlgoMainLineTree
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getDirection() throws IOException, AutomationException
getDirection
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.getPageLayout()
public void setDirection(int pVal) throws IOException, AutomationException
setDirection
in interface ISchematicAlgoMainLineTree
pVal
- A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPageLayout() throws IOException, AutomationException
getPageLayout
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.getDirection()
public void setPageLayout(int pVal) throws IOException, AutomationException
setPageLayout
in interface ISchematicAlgoMainLineTree
pVal
- A com.esri.arcgis.schematic.esriSchematicAlgoMainLineType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isOrthogonalDisplay() throws IOException, AutomationException
isOrthogonalDisplay
in interface ISchematicAlgoMainLineTree
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ISchematicAlgoMainLineTree.getBreakPoint()
public void setOrthogonalDisplay(boolean pVal) throws IOException, AutomationException
setOrthogonalDisplay
in interface ISchematicAlgoMainLineTree
pVal
- 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 DistanceAlongTheDirection property value is 2, the distance that separates two nodes belonging to the (n) and the (n+1) hierarchical levels corresponds to the average size of two symbols placed side by side.
isAbsoluteParameters
in interface ISchematicAlgoMainLineTree
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 ISchematicAlgoMainLineTree
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |