com.esri.arcgis.schematic
Interface INgProjectAlgorithm

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgProjectAlgorithmProxy, NgProject

public interface INgProjectAlgorithm
extends Serializable

Provides access to members that control the management of the schematic algorithms for the graphic project.

Product Availability

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

See Also:

INgProjectAnalyst, INgProject

Method Summary

void	addAlgorithm(String cLSID, ISchematicAlgorithm algorithm) Adds the specified schematic algorithm to the project.
ISchematicAlgorithm	getAlgorithm(String cLSID) Returns the specified schematic algorithm defined for the project.
ISchematicAlgorithms	getAlgorithms() List of the schematic algorithms defined for the project.
ISchematicAlgorithmSheet	getAlgorithmSheet() Properties page of the schematic algorithm.
void	removeAlgorithm(String cLSID) Removes the specified schematic algorithm from the project.
void	removeAlgorithms() Remove all the schematic algorithms from the project.

Method Detail

getAlgorithmSheet

ISchematicAlgorithmSheet getAlgorithmSheet()
                                           throws IOException,
                                                  AutomationException

Properties page of the schematic algorithm.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithmSheet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAnalyst.getAnalystSheet()

addAlgorithm

void addAlgorithm(String cLSID,
                  ISchematicAlgorithm algorithm)
                  throws IOException,
                         AutomationException

Adds the specified schematic algorithm to the project.

Product Availability

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

Parameters:

cLSID - The cLSID (in)

algorithm - A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAlgorithm

void removeAlgorithm(String cLSID)
                     throws IOException,
                            AutomationException

Removes the specified schematic algorithm from the project.

Product Availability

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

Parameters:

cLSID - The cLSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.removeAlgorithms()

getAlgorithms

ISchematicAlgorithms getAlgorithms()
                                   throws IOException,
                                          AutomationException

List of the schematic algorithms defined for the project.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithms

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.getAlgorithm(String)

removeAlgorithms

void removeAlgorithms()
                      throws IOException,
                             AutomationException

Remove all the schematic algorithms from the project.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.removeAlgorithm(String)

getAlgorithm

ISchematicAlgorithm getAlgorithm(String cLSID)
                                 throws IOException,
                                        AutomationException

Returns the specified schematic algorithm defined for the project.

Product Availability

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

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicAlgorithm

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgProjectAlgorithm.getAlgorithms()