com.esri.arcgis.schematic
Interface ISchematicInMemoryDiagram

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicInMemoryDiagramProxy, SchematicInMemoryDiagram

public interface ISchematicInMemoryDiagram
extends Serializable

Provides access to members that manage the schematic in memory diagram.

Description

The ISchematicInMemoryDiagram is the central object allowing to access a schematic diagram when it is loaded in memory.

Product Availability

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

Method Summary

String	getName() Name of the schematic in memory diagram.
ISchematicDiagram	getSchematicDiagram() The schematic diagram relative to the schematic in memory diagram.
ISchematicDiagramClass	getSchematicDiagramClass() The schematic diagram class the schematic in memory diagram belongs to.
ISchematicInMemoryFeature	getSchematicInMemoryFeatureByType(int elementType, String name) Finds a schematic in memory feature referenced by the specified name and the specified element type within the schematic in memory net feature.
IEnumSchematicInMemoryFeature	getSchematicInMemoryFeatures() Schematic in memory features enumeration within the schematic in memory diagram.
IEnumSchematicInMemoryFeature	getSchematicInMemoryFeaturesByClass(ISchematicElementClass schematicElementClass) Finds a schematic in memory features enumeration by the specified schematic element class within the schematic in memory net feature.
IEnumSchematicInMemoryFeature	getSchematicInMemoryFeaturesByType(int elementType) Finds a schematic in memory features enumeration by the specified element type within the schematic in memory net feature.
boolean	isHasChanged() Indicates if the schematic in memory diagram has changed in the current session.
boolean	isLayoutHasChanged() Indicates if the saved layout of the schematic diagram is no more the initial layout.
void	refresh() Refreshes the schematic in memory diagram.
void	save(ILayer layer) Saves the schematic in memory diagram.
void	setHasChanged(boolean hasChanged) Indicates if the schematic in memory diagram has changed in the current session.
void	setLayoutHasChanged(boolean layoutHasChanged) Indicates if the saved layout of the schematic diagram is no more the initial layout.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the schematic in memory diagram.

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.

getSchematicDiagram

ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException

The schematic diagram relative to the schematic in memory diagram.

Product Availability

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

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.

getSchematicDiagramClass

ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException

The schematic diagram class the schematic in memory diagram belongs to.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(ILayer layer)
          throws IOException,
                 AutomationException

Saves the schematic in memory diagram.

Description

During the diagram saving, the changes on the in-memory features in the in-memory diagram are reported on the related schematic elements in the schematic database.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Refreshes the schematic in memory diagram.

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.

getSchematicInMemoryFeatures

IEnumSchematicInMemoryFeature getSchematicInMemoryFeatures()
                                                           throws IOException,
                                                                  AutomationException

Schematic in memory features enumeration within the schematic in memory diagram.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryFeatureByType

ISchematicInMemoryFeature getSchematicInMemoryFeatureByType(int elementType,
                                                            String name)
                                                            throws IOException,
                                                                   AutomationException

Finds a schematic in memory feature referenced by the specified name and the specified element type within the schematic in memory net feature.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryFeaturesByType

IEnumSchematicInMemoryFeature getSchematicInMemoryFeaturesByType(int elementType)
                                                                 throws IOException,
                                                                        AutomationException

Finds a schematic in memory features enumeration by the specified element type within the schematic in memory net feature.

Product Availability

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

Parameters:

elementType - A com.esri.arcgis.schematic.esriSchematicElementType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryFeaturesByClass

IEnumSchematicInMemoryFeature getSchematicInMemoryFeaturesByClass(ISchematicElementClass schematicElementClass)
                                                                  throws IOException,
                                                                         AutomationException

Finds a schematic in memory features enumeration by the specified schematic element class within the schematic in memory net feature.

Product Availability

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

Parameters:

schematicElementClass - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChanged

boolean isHasChanged()
                     throws IOException,
                            AutomationException

Indicates if the schematic in memory diagram has changed in the current session.

Product Availability

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

Returns:

The hasChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasChanged

void setHasChanged(boolean hasChanged)
                   throws IOException,
                          AutomationException

Indicates if the schematic in memory diagram has changed in the current session.

Product Availability

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

Parameters:

hasChanged - The hasChanged (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLayoutHasChanged

boolean isLayoutHasChanged()
                           throws IOException,
                                  AutomationException

Indicates if the saved layout of the schematic diagram is no more the initial layout.

Product Availability

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

Returns:

The layoutHasChanged

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayoutHasChanged

void setLayoutHasChanged(boolean layoutHasChanged)
                         throws IOException,
                                AutomationException

Indicates if the saved layout of the schematic diagram is no more the initial layout.

Product Availability

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

Parameters:

layoutHasChanged - The layoutHasChanged (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.