Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic
Interface ISchematicAlgorithm

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ISchematicAlgoAngleDirected, ISchematicAlgoBypassNode, ISchematicAlgoCompactTree, ISchematicAlgoComposite, ISchematicAlgoCompression, ISchematicAlgoForceDirected, ISchematicAlgoGrid, ISchematicAlgoInitialPositions, ISchematicAlgoLinearDispatch, ISchematicAlgoMainLineTree, ISchematicAlgoMainRing, ISchematicAlgoMarkCrossings, ISchematicAlgoOrthogonal, ISchematicAlgoPartialOverlappingLinks, ISchematicAlgoRadialTree, ISchematicAlgoReduceVertices, ISchematicAlgoRelativeMainLine, ISchematicAlgoRestoreSavedPositions, ISchematicAlgoRotateNodesAlongLinks, ISchematicAlgoRotateTree, ISchematicAlgoSeparateOverlappingLinks, ISchematicAlgoSmartTree, ISchematicAlgoSpatialDispatch, ISchematicAlgoSquareLinks, ISchematicAnalystFindConnected, ISchematicAnalystFindLoops, ISchematicAnalystFindOverlappingLinks, ISchematicAnalystFindPath, ISchematicAnalystTraceResult
All Known Implementing Classes:
ISchematicAlgoAngleDirectedProxy, ISchematicAlgoBypassNodeProxy, ISchematicAlgoCompactTreeProxy, ISchematicAlgoCompositeProxy, ISchematicAlgoCompressionProxy, ISchematicAlgoForceDirectedProxy, ISchematicAlgoGridProxy, ISchematicAlgoInitialPositionsProxy, ISchematicAlgoLinearDispatchProxy, ISchematicAlgoMainLineTreeProxy, ISchematicAlgoMainRingProxy, ISchematicAlgoMarkCrossingsProxy, ISchematicAlgoOrthogonalProxy, ISchematicAlgoPartialOverlappingLinksProxy, ISchematicAlgoRadialTreeProxy, ISchematicAlgoReduceVerticesProxy, ISchematicAlgoRelativeMainLineProxy, ISchematicAlgoRestoreSavedPositionsProxy, ISchematicAlgorithmProxy, ISchematicAlgoRotateNodesAlongLinksProxy, ISchematicAlgoRotateTreeProxy, ISchematicAlgoSeparateOverlappingLinksProxy, ISchematicAlgoSmartTreeProxy, ISchematicAlgoSpatialDispatchProxy, ISchematicAlgoSquareLinksProxy, ISchematicAnalystFindConnectedProxy, ISchematicAnalystFindLoopsProxy, ISchematicAnalystFindOverlappingLinksProxy, ISchematicAnalystFindPathProxy, ISchematicAnalystTraceResultProxy, SchematicAlgoAngleDirected, SchematicAlgoBypassNode, SchematicAlgoCompactTree, SchematicAlgoComposite, SchematicAlgoCompression, SchematicAlgoForceDirected, SchematicAlgoGrid, SchematicAlgoInitialPositions, SchematicAlgoLinearDispatch, SchematicAlgoMainLineTree, SchematicAlgoMainRing, SchematicAlgoMarkCrossings, SchematicAlgoOrthogonal, SchematicAlgoPartialOverlappingLinks, SchematicAlgoRadialTree, SchematicAlgoReduceVertices, SchematicAlgoRelativeMainLine, SchematicAlgoRestoreSavedPositions, SchematicAlgoRotateNodesAlongLinks, SchematicAlgoRotateTree, SchematicAlgoSeparateOverlappingLinks, SchematicAlgoSmartTree, SchematicAlgoSpatialDispatch, SchematicAlgoSquareLinks, SchematicAnalystFindConnected, SchematicAnalystFindLoops, SchematicAnalystFindOverlappingLinks, SchematicAnalystFindPath
public interface ISchematicAlgorithm
extends java.io.Serializable

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

Description: 'Provides access to members that control the 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 IIDbef20014_837c_4387_83ba_8523b7897a36
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker)
          Execute the schematic algorithm.
 java.lang.String getAlgorithmCLSID()
          The CLSID of the algorithm.
 java.lang.String getLabel()
          The label of the algorithm.
 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.
 boolean isAvailable()
          Indicates if the algorithm is currently available.
 boolean isEnabled(ISchematicLayer schematicLayer)
          Indicates if the algorithm is currently enabled.
 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 setAvailable(boolean available)
          Indicates if the algorithm is currently available.
 void setLabel(java.lang.String label)
          The label of the algorithm.
 void setOverridable(boolean pOverridable)
          Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
 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.
 

Field Detail

IIDbef20014_837c_4387_83ba_8523b7897a36

static final int IIDbef20014_837c_4387_83ba_8523b7897a36
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

isEnabled

boolean isEnabled(ISchematicLayer schematicLayer)
                  throws java.io.IOException,
                         AutomationException
Indicates if the algorithm is currently enabled.

Parameters:
schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)
Returns:
The enabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvailable

boolean isAvailable()
                    throws java.io.IOException,
                           AutomationException
Indicates if the algorithm is currently available.

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

setAvailable

void setAvailable(boolean available)
                  throws java.io.IOException,
                         AutomationException
Indicates if the algorithm is currently available.

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

isOverridable

boolean isOverridable()
                      throws java.io.IOException,
                             AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

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

setOverridable

void setOverridable(boolean pOverridable)
                    throws java.io.IOException,
                           AutomationException
Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

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

getSchematicDiagramClassName

ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws java.io.IOException,
                                                               AutomationException
The diagram class object used to initialize the algorithm.

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

setSchematicDiagramClassNameByRef

void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws java.io.IOException,
                                              AutomationException
The diagram class object used to initialize the algorithm.

Parameters:
schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException
The label of the algorithm.

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

setLabel

void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException
The label of the algorithm.

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

isUseRootNode

boolean isUseRootNode()
                      throws java.io.IOException,
                             AutomationException
Indicates if the algorithm use root nodes.

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

isUseEndNode

boolean isUseEndNode()
                     throws java.io.IOException,
                            AutomationException
Indicates if the algorithm use end nodes.

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

getPropertySet

IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

void setPropertySet(IPropertySet propertySet)
                    throws java.io.IOException,
                           AutomationException
The property set of the algorithm contains a collection of its parameters and their values.

Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithmCLSID

java.lang.String getAlgorithmCLSID()
                                   throws java.io.IOException,
                                          AutomationException
The CLSID of the algorithm.

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

execute

void execute(ISchematicLayer schematicLayer,
             ITrackCancel cancelTracker)
             throws java.io.IOException,
                    AutomationException
Execute the schematic algorithm.

Parameters:
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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD