com.esri.arcgis.schematic
Interface IGPSchematicBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGPSchematicBuilderProxy, SchematicDiagramClass

public interface IGPSchematicBuilder
extends Serializable

Provides access to members that manage the generation/update of diagrams by GP tools.

Product Availability

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

Method Summary

ISchematicDiagram	gPGenerateDiagram(String diagramName, ISchematicDiagramContainer diagramContainer, IEnumGPValue enumGPValue, String builderOptions, ITrackCancel cancelTracker, IGPMessages messages) Generates a new schematic diagram from an enum of GP values.
void	gPUpdateDiagram(ISchematicDiagram diagram, IEnumGPValue enumGPValue, String builderOptions, ITrackCancel cancelTracker, IGPMessages messages) Updates an existing diagram from an enum of GP values.

Method Detail

gPGenerateDiagram

ISchematicDiagram gPGenerateDiagram(String diagramName,
                                    ISchematicDiagramContainer diagramContainer,
                                    IEnumGPValue enumGPValue,
                                    String builderOptions,
                                    ITrackCancel cancelTracker,
                                    IGPMessages messages)
                                    throws IOException,
                                           AutomationException

Generates a new schematic diagram from an enum of GP values.

Product Availability

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

Parameters:

diagramName - The diagramName (in)

diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in)

enumGPValue - A reference to a com.esri.arcgis.geodatabase.IEnumGPValue (in, optional, pass 0 if not required)

builderOptions - The builderOptions (in, optional, pass 0 if not required)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

gPUpdateDiagram

void gPUpdateDiagram(ISchematicDiagram diagram,
                     IEnumGPValue enumGPValue,
                     String builderOptions,
                     ITrackCancel cancelTracker,
                     IGPMessages messages)
                     throws IOException,
                            AutomationException

Updates an existing diagram from an enum of GP values.

Product Availability

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

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

enumGPValue - A reference to a com.esri.arcgis.geodatabase.IEnumGPValue (in, optional, pass 0 if not required)

builderOptions - The builderOptions (in, optional, pass 0 if not required)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.