com.esri.arcgis.schematic
Interface ISchematicElementClass

All Superinterfaces:

ISchematicObjectClass, Serializable

All Known Implementing Classes:

ISchematicElementClassProxy, SchematicElementClass

public interface ISchematicElementClass
extends ISchematicObjectClass, Serializable

Provides access to members that manage the schematic element class.

Description

A schematic element class allows implementation of a particular type of schematic elements expected in diagrams implemented by a particular schematic diagram class. It is a collection of schematic elements that share the same type of schematic elements (nodes, links, and so on), the same geometry type (point, line, or polygon), and the same schematic attributes for a common area.

A schematic element class can be associated with one or several schematic diagram classes that implement schematic diagrams containing the schematic elements implemented by this schematic element class. It is assigned to one schematic dataset, although more than one schematic element class can be defined for the same schematic dataset. Schematic element classes always exist as physical feature classes in the schematic dataset and contain the schematic elements they implement.

Product Availability

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

Method Summary

void	alterAssociatedObjectClass(ISchematicDataSource schematicDataSource, int objectClassID) Changes the associated object class to the schematic element class.
ISchematicElement	createSchematicElement(String name, IGeometry geometry, ISchematicDiagram schematicDiagram) Creates a new schematic element in the specified schematic diagram.
ISchematicDataSource	getAssociatedObjectClassDataSource() The associated schematic data source to the schematic element class.
int	getAssociatedObjectClassDataSourceID() The associated object class data source ID to the schematic element class.
int	getAssociatedObjectClassID() The associated object class ID to the schematic element class.
IEnumSchematicDiagramClass	getAssociatedSchematicDiagramClasses() Associated diagram classes to the schematic element class.
int	getGeometryType() Geometry type of the schematic element class.
ISchematicElementClass	getParent() Parent to the schematic element class.
IUID	getRelationManagerCLSID() Relation manager CLSID of the schematic element class.
ISchematicElement	getSchematicElementByID(int iD, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified ID that is contained in the specified schematic diagram.
ISchematicElement	getSchematicElementByName(String name, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified Name that is contained in the specified schematic diagram.
IEnumSchematicElement	getSchematicElements(ISchematicDiagram schematicDiagram) List of the schematic elements related to the schematic element class within the specified schematic diagram.
int	getSchematicElementType() Schematic element type related to the schematic element class.
IField	getShapeField() Shape field of the schematic element class.
void	setGeometryType(int geometryType) Geometry type of the schematic element class.
void	setParentByRef(ISchematicElementClass parent) Parent to the schematic element class.
void	setRelationManagerCLSID(IUID uID) Relation manager CLSID of the schematic element class.
void	setShapeField(IField field) Shape field of the schematic element class.

Methods inherited from interface com.esri.arcgis.schematic.ISchematicObjectClass

createSchematicAttribute, delete, getExternalQueryEvaluationMode, getIdentifierFieldNames, getName, getPredefinedAttributeNames, getQueryString, getSchematicDataset, getSchematicDataSource, getSchematicQueryParameters, setExternalQueryEvaluationMode, setIdentifierFieldNames, setName, setQueryString, setSchematicDataSourceByRef, setSchematicQueryParameters

Method Detail

createSchematicElement

ISchematicElement createSchematicElement(String name,
                                         IGeometry geometry,
                                         ISchematicDiagram schematicDiagram)
                                         throws IOException,
                                                AutomationException

Creates a new schematic element in the specified schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElements

IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
                                           throws IOException,
                                                  AutomationException

List of the schematic elements related to the schematic element class within the specified schematic diagram.

Product Availability

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

Parameters:

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByID

ISchematicElement getSchematicElementByID(int iD,
                                          ISchematicDiagram schematicDiagram)
                                          throws IOException,
                                                 AutomationException

Schematic element referenced by the specified ID that is contained in the specified schematic diagram.

Product Availability

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

Parameters:

iD - The iD (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByName

ISchematicElement getSchematicElementByName(String name,
                                            ISchematicDiagram schematicDiagram)
                                            throws IOException,
                                                   AutomationException

Schematic element referenced by the specified Name that is contained in the specified schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementType

int getSchematicElementType()
                            throws IOException,
                                   AutomationException

Schematic element type related to the schematic element class.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryType

int getGeometryType()
                    throws IOException,
                           AutomationException

Geometry type of the schematic element class.

Product Availability

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

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryType

void setGeometryType(int geometryType)
                     throws IOException,
                            AutomationException

Geometry type of the schematic element class.

Product Availability

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

Parameters:

geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeField

IField getShapeField()
                     throws IOException,
                            AutomationException

Shape field of the schematic element class.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeField

void setShapeField(IField field)
                   throws IOException,
                          AutomationException

Shape field of the schematic element class.

Product Availability

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

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

ISchematicElementClass getParent()
                                 throws IOException,
                                        AutomationException

Parent to the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentByRef

void setParentByRef(ISchematicElementClass parent)
                    throws IOException,
                           AutomationException

Parent to the schematic element class.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedSchematicDiagramClasses

IEnumSchematicDiagramClass getAssociatedSchematicDiagramClasses()
                                                                throws IOException,
                                                                       AutomationException

Associated diagram classes to the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationManagerCLSID

IUID getRelationManagerCLSID()
                             throws IOException,
                                    AutomationException

Relation manager CLSID of the schematic element class.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationManagerCLSID

void setRelationManagerCLSID(IUID uID)
                             throws IOException,
                                    AutomationException

Relation manager CLSID of the schematic element class.

Product Availability

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

Parameters:

uID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassID

int getAssociatedObjectClassID()
                               throws IOException,
                                      AutomationException

The associated object class ID to the schematic element class.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSourceID

int getAssociatedObjectClassDataSourceID()
                                         throws IOException,
                                                AutomationException

The associated object class data source ID to the schematic element class.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSource

ISchematicDataSource getAssociatedObjectClassDataSource()
                                                        throws IOException,
                                                               AutomationException

The associated schematic data source to the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterAssociatedObjectClass

void alterAssociatedObjectClass(ISchematicDataSource schematicDataSource,
                                int objectClassID)
                                throws IOException,
                                       AutomationException

Changes the associated object class to the schematic element class.

Product Availability

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

Parameters:

schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)

objectClassID - The objectClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.