com.esri.arcgis.schematic
Interface ISchematicAlgoRelativeMainLine

All Superinterfaces:
ISchematicAlgorithm, java.io.Serializable
All Known Implementing Classes:
ISchematicAlgoRelativeMainLineProxy, SchematicAlgoRelativeMainLine

public interface ISchematicAlgoRelativeMainLine
extends ISchematicAlgorithm, java.io.Serializable

COM Interface 'ISchematicAlgoRelativeMainLine'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that control the Relative Main Line schematic algorithm.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID9b152a92_af41_4fa3_a18d_5b11e0a63b65
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm
IIDbef20014_837c_4387_83ba_8523b7897a36
 
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.
 java.lang.String getExcludedTypeValues()
          Excluded type values.
 java.lang.String getLengthAttributeName()
          The name of the attribute holding the initial length of the link.
 java.lang.String getLinesAttributeName()
          The name of the attribute defining the parallel lines.
 java.lang.String getMainLinesTypeValue()
          Define the main line type value.
 double getMinimalDistanceBetweenNodes()
          Minimal distance between nodes along direction defines where compression can occur.
 java.lang.String getPriorityAttributeName()
          The name of the attribute defining the priority..
 java.lang.String getPriorityValue()
          Define the priority value.
 java.lang.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(java.lang.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(java.lang.String name)
          The name of the attribute holding the initial length of the link.
 void setLinesAttributeName(java.lang.String name)
          The name of the attribute defining the parallel lines.
 void setMainLinesTypeValue(java.lang.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(java.lang.String name)
          The name of the attribute defining the priority..
 void setPriorityValue(java.lang.String value)
          Define the priority value.
 void setTypeAttributeName(java.lang.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
 

Field Detail

IID9b152a92_af41_4fa3_a18d_5b11e0a63b65

static final int IID9b152a92_af41_4fa3_a18d_5b11e0a63b65
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getDirection

int getDirection()
                 throws java.io.IOException,
                        AutomationException
RelativeMainLine structure direction.

Returns:
A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int pVal)
                  throws java.io.IOException,
                         AutomationException
RelativeMainLine structure direction.

Parameters:
pVal - A com.esri.arcgis.schematic.esriSchematicAlgoDirection constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceBetweenBranches

double getDistanceBetweenBranches()
                                  throws java.io.IOException,
                                         AutomationException
Spacing between the branches perpendicularly to the direction.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceBetweenBranches

void setDistanceBetweenBranches(double pVal)
                                throws java.io.IOException,
                                       AutomationException
Spacing between the branches perpendicularly to the direction.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakPointAngle

double getBreakPointAngle()
                          throws java.io.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.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBreakPointAngle

void setBreakPointAngle(double pVal)
                        throws java.io.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.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCompressAlongDirection

boolean isCompressAlongDirection()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if the algorithm shrinks the distances between nodes along the direction.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompressAlongDirection

void setCompressAlongDirection(boolean pVal)
                               throws java.io.IOException,
                                      AutomationException
Indicates if the algorithm shrinks the distances between nodes along the direction.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimalDistanceBetweenNodes

double getMinimalDistanceBetweenNodes()
                                      throws java.io.IOException,
                                             AutomationException
Minimal distance between nodes along direction defines where compression can occur.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimalDistanceBetweenNodes

void setMinimalDistanceBetweenNodes(double pVal)
                                    throws java.io.IOException,
                                           AutomationException
Minimal distance between nodes along direction defines where compression can occur.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCompression

double getCompression()
                      throws java.io.IOException,
                             AutomationException
Number comprised between 0 and 1 that define the percentage of compression along the direction.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompression

void setCompression(double pVal)
                    throws java.io.IOException,
                           AutomationException
Number comprised between 0 and 1 that define the percentage of compression along the direction.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLinesAttributeName

java.lang.String getLinesAttributeName()
                                       throws java.io.IOException,
                                              AutomationException
The name of the attribute defining the parallel lines.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLinesAttributeName

void setLinesAttributeName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException
The name of the attribute defining the parallel lines.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseTypeAttribute

boolean isUseTypeAttribute()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the algorithm uses type values to distinguish between lines.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseTypeAttribute

void setUseTypeAttribute(boolean pVal)
                         throws java.io.IOException,
                                AutomationException
Indicates if the algorithm uses type values to distinguish between lines.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTypeAttributeName

java.lang.String getTypeAttributeName()
                                      throws java.io.IOException,
                                             AutomationException
The name of the attribute defining the type of the lines.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTypeAttributeName

void setTypeAttributeName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The name of the attribute defining the type of the lines.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMainLinesTypeValue

java.lang.String getMainLinesTypeValue()
                                       throws java.io.IOException,
                                              AutomationException
Define the main line type value.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMainLinesTypeValue

void setMainLinesTypeValue(java.lang.String value)
                           throws java.io.IOException,
                                  AutomationException
Define the main line type value.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludedTypeValues

java.lang.String getExcludedTypeValues()
                                       throws java.io.IOException,
                                              AutomationException
Excluded type values.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludedTypeValues

void setExcludedTypeValues(java.lang.String value)
                           throws java.io.IOException,
                                  AutomationException
Excluded type values.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsePriorityAttribute

boolean isUsePriorityAttribute()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the algorithm uses priority attribute to merge connected main lines.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUsePriorityAttribute

void setUsePriorityAttribute(boolean pVal)
                             throws java.io.IOException,
                                    AutomationException
Indicates if the algorithm uses priority attribute to merge connected main lines.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriorityAttributeName

java.lang.String getPriorityAttributeName()
                                          throws java.io.IOException,
                                                 AutomationException
The name of the attribute defining the priority..

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriorityAttributeName

void setPriorityAttributeName(java.lang.String name)
                              throws java.io.IOException,
                                     AutomationException
The name of the attribute defining the priority..

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriorityValue

java.lang.String getPriorityValue()
                                  throws java.io.IOException,
                                         AutomationException
Define the priority value.

Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriorityValue

void setPriorityValue(java.lang.String value)
                      throws java.io.IOException,
                             AutomationException
Define the priority value.

Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInitialLengthIsGeometry

boolean isInitialLengthIsGeometry()
                                  throws java.io.IOException,
                                         AutomationException
Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitialLengthIsGeometry

void setInitialLengthIsGeometry(boolean pVal)
                                throws java.io.IOException,
                                       AutomationException
Indicates if the initial length is computed from the link geometry or fetched from an attibute.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

java.lang.String getLengthAttributeName()
                                        throws java.io.IOException,
                                               AutomationException
The name of the attribute holding the initial length of the link.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

void setLengthAttributeName(java.lang.String name)
                            throws java.io.IOException,
                                   AutomationException
The name of the attribute holding the initial length of the link.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVerticesHint

boolean isVerticesHint()
                       throws java.io.IOException,
                              AutomationException
Indicates if the link vertices are used to determine the side and orientation of the branches.

Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticesHint

void setVerticesHint(boolean pVal)
                     throws java.io.IOException,
                            AutomationException
Indicates if the link vertices are used to determine the side and orientation of the branches.

Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.