com.esri.arcgis.schematic
Interface ISchematicAlgoRelativeMainLine

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoRelativeMainLine

public interface ISchematicAlgoRelativeMainLine
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Relative Main Line schematic algorithm.

Description

The Relative Main Line algorithm arranges the schematic nodes and links in a schematic diagram along parallel straight lines for which all the connected links have the same attribute value and places the branches coming from those lines, preserving both their directions with regard to the straight lines and distances proportional to the initial distances and relative to each other.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

double	getBreakPointAngle() Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.
double	getCompression() Number comprised between 0 and 1 that define the percentage of compression along the direction.
int	getDirection() RelativeMainLine structure direction.
double	getDistanceBetweenBranches() Spacing between the branches perpendicularly to the direction.
String	getExcludedTypeValues() Excluded type values.
String	getLengthAttributeName() The name of the attribute holding the initial length of the link.
String	getLinesAttributeName() The name of the attribute defining the parallel lines.
String	getMainLinesTypeValue() Define the main line type value.
double	getMinimalDistanceBetweenNodes() Minimal distance between nodes along direction defines where compression can occur.
String	getPriorityAttributeName() The name of the attribute defining the priority..
String	getPriorityValue() Define the priority value.
String	getTypeAttributeName() The name of the attribute defining the type of the lines.
boolean	isCompressAlongDirection() Indicates if the algorithm shrinks the distances between nodes along the direction.
boolean	isInitialLengthIsGeometry() Indicates if the initial length is computed from the link geometry or fetched from an attibute.
boolean	isUsePriorityAttribute() Indicates if the algorithm uses priority attribute to merge connected main lines.
boolean	isUseTypeAttribute() Indicates if the algorithm uses type values to distinguish between lines.
boolean	isVerticesHint() Indicates if the link vertices are used to determine the side and orientation of the branches.
void	setBreakPointAngle(double pVal) Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.
void	setCompressAlongDirection(boolean pVal) Indicates if the algorithm shrinks the distances between nodes along the direction.
void	setCompression(double pVal) Number comprised between 0 and 1 that define the percentage of compression along the direction.
void	setDirection(int pVal) RelativeMainLine structure direction.
void	setDistanceBetweenBranches(double pVal) Spacing between the branches perpendicularly to the direction.
void	setExcludedTypeValues(String value) Excluded type values.
void	setInitialLengthIsGeometry(boolean pVal) Indicates if the initial length is computed from the link geometry or fetched from an attibute.
void	setLengthAttributeName(String name) The name of the attribute holding the initial length of the link.
void	setLinesAttributeName(String name) The name of the attribute defining the parallel lines.
void	setMainLinesTypeValue(String value) Define the main line type value.
void	setMinimalDistanceBetweenNodes(double pVal) Minimal distance between nodes along direction defines where compression can occur.
void	setPriorityAttributeName(String name) The name of the attribute defining the priority..
void	setPriorityValue(String value) Define the priority value.
void	setTypeAttributeName(String name) The name of the attribute defining the type of the lines.
void	setUsePriorityAttribute(boolean pVal) Indicates if the algorithm uses priority attribute to merge connected main lines.
void	setUseTypeAttribute(boolean pVal) Indicates if the algorithm uses type values to distinguish between lines.
void	setVerticesHint(boolean pVal) Indicates if the link vertices are used to determine the side and orientation of the branches.

Methods inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm

execute, getAlgorithmCLSID, getLabel, getPropertySet, getSchematicDiagramClassName, isAvailable, isEnabled, isOverridable, isUseEndNode, isUseRootNode, setAvailable, setLabel, setOverridable, setPropertySet, setSchematicDiagramClassNameByRef

Method Detail

getDirection

int getDirection()
                 throws IOException,
                        AutomationException

RelativeMainLine structure direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int pVal)
                  throws IOException,
                         AutomationException

RelativeMainLine structure direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceBetweenBranches

double getDistanceBetweenBranches()
                                  throws IOException,
                                         AutomationException

Spacing between the branches perpendicularly to the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceBetweenBranches

void setDistanceBetweenBranches(double pVal)
                                throws IOException,
                                       AutomationException

Spacing between the branches perpendicularly to the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakPointAngle

double getBreakPointAngle()
                          throws IOException,
                                 AutomationException

Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakPointAngle

void setBreakPointAngle(double pVal)
                        throws IOException,
                               AutomationException

Angle comprised between 30° and 90° that defines the relative position of the break point on the first and last segments of the links; that is on the link segments that are paralleled to the tree direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCompressAlongDirection

boolean isCompressAlongDirection()
                                 throws IOException,
                                        AutomationException

Indicates if the algorithm shrinks the distances between nodes along the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressAlongDirection

void setCompressAlongDirection(boolean pVal)
                               throws IOException,
                                      AutomationException

Indicates if the algorithm shrinks the distances between nodes along the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimalDistanceBetweenNodes

double getMinimalDistanceBetweenNodes()
                                      throws IOException,
                                             AutomationException

Minimal distance between nodes along direction defines where compression can occur.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimalDistanceBetweenNodes

void setMinimalDistanceBetweenNodes(double pVal)
                                    throws IOException,
                                           AutomationException

Minimal distance between nodes along direction defines where compression can occur.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompression

double getCompression()
                      throws IOException,
                             AutomationException

Number comprised between 0 and 1 that define the percentage of compression along the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompression

void setCompression(double pVal)
                    throws IOException,
                           AutomationException

Number comprised between 0 and 1 that define the percentage of compression along the direction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinesAttributeName

String getLinesAttributeName()
                             throws IOException,
                                    AutomationException

The name of the attribute defining the parallel lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinesAttributeName

void setLinesAttributeName(String name)
                           throws IOException,
                                  AutomationException

The name of the attribute defining the parallel lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTypeAttribute

boolean isUseTypeAttribute()
                           throws IOException,
                                  AutomationException

Indicates if the algorithm uses type values to distinguish between lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTypeAttribute

void setUseTypeAttribute(boolean pVal)
                         throws IOException,
                                AutomationException

Indicates if the algorithm uses type values to distinguish between lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeAttributeName

String getTypeAttributeName()
                            throws IOException,
                                   AutomationException

The name of the attribute defining the type of the lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeAttributeName

void setTypeAttributeName(String name)
                          throws IOException,
                                 AutomationException

The name of the attribute defining the type of the lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMainLinesTypeValue

String getMainLinesTypeValue()
                             throws IOException,
                                    AutomationException

Define the main line type value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMainLinesTypeValue

void setMainLinesTypeValue(String value)
                           throws IOException,
                                  AutomationException

Define the main line type value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludedTypeValues

String getExcludedTypeValues()
                             throws IOException,
                                    AutomationException

Excluded type values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludedTypeValues

void setExcludedTypeValues(String value)
                           throws IOException,
                                  AutomationException

Excluded type values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsePriorityAttribute

boolean isUsePriorityAttribute()
                               throws IOException,
                                      AutomationException

Indicates if the algorithm uses priority attribute to merge connected main lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsePriorityAttribute

void setUsePriorityAttribute(boolean pVal)
                             throws IOException,
                                    AutomationException

Indicates if the algorithm uses priority attribute to merge connected main lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriorityAttributeName

String getPriorityAttributeName()
                                throws IOException,
                                       AutomationException

The name of the attribute defining the priority..

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriorityAttributeName

void setPriorityAttributeName(String name)
                              throws IOException,
                                     AutomationException

The name of the attribute defining the priority..

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriorityValue

String getPriorityValue()
                        throws IOException,
                               AutomationException

Define the priority value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriorityValue

void setPriorityValue(String value)
                      throws IOException,
                             AutomationException

Define the priority value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitialLengthIsGeometry

boolean isInitialLengthIsGeometry()
                                  throws IOException,
                                         AutomationException

Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialLengthIsGeometry

void setInitialLengthIsGeometry(boolean pVal)
                                throws IOException,
                                       AutomationException

Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

String getLengthAttributeName()
                              throws IOException,
                                     AutomationException

The name of the attribute holding the initial length of the link.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

void setLengthAttributeName(String name)
                            throws IOException,
                                   AutomationException

The name of the attribute holding the initial length of the link.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVerticesHint

boolean isVerticesHint()
                       throws IOException,
                              AutomationException

Indicates if the link vertices are used to determine the side and orientation of the branches.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticesHint

void setVerticesHint(boolean pVal)
                     throws IOException,
                            AutomationException

Indicates if the link vertices are used to determine the side and orientation of the branches.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.