com.esri.arcgis.schematic
Interface ISchematicDiagramClass

All Superinterfaces:

ISchematicObjectClass, Serializable

All Known Implementing Classes:

ISchematicDiagramClassProxy, SchematicDiagramClass

public interface ISchematicDiagramClass
extends ISchematicObjectClass, Serializable

Provides access to members that manage the schematic diagram class.

Description

A schematic diagram class holds the database and configuration properties defining the content and presentation of one or several schematic diagrams that will be generated. It holds the properties defining the representation of feature layers that compose the schematic diagrams and so behaves as the template for the display properties of specific schematic diagrams of a network. It allows generation of a particular type of schematic diagram containing a set of expected types of schematic features. Typically, in the example of an electric network, a schematic diagram class can be defined for a schematic of primaries and switches, and another diagram class can be defined for a schematic of the internal diagrams (inside plant) of the devices.

A schematic diagram class is assigned to one schematic dataset, although more than one schematic diagram class can be defined for the same schematic dataset.

Product Availability

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

Method Summary

void	associateSchematicElementClass(ISchematicElementClass schematicElementClass) Associates the element class to the schematic diagram class.
ISchematicDiagram	createSchematicDiagram(String name, ISchematicDiagramContainer diagramContainer) Creates a new schematic diagram.
void	dissociateSchematicElementClass(ISchematicElementClass schematicElementClass) Dissociates the element class from the schematic diagram class.
IEnumSchematicElementClass	getAssociatedSchematicElementClasses() The associated element classes to the schematic diagram class.
ISchematicElementClass	getDefaultSchematicNodeClass() Default schematic in memory node element class related to the schematic diagram class.
ISchematicDiagramClass	getParent() Parent of the schematic diagram class.
ISchematicAlgorithm	getSchematicAlgorithm() Schematic algorithm of the schematic diagram class.
IEnumSchematicAlgorithm	getSchematicAlgorithms() Schematic algorithms of the schematic diagram class.
ISchematicBuilder	getSchematicBuilder() Schematic builder of the schematic diagram class.
ISchematicDiagram	getSchematicDiagramByID(int iD) Schematic diagram referenced by the specified ID.
ISchematicDiagram	getSchematicDiagramByName(String name) Schematic diagram referenced by the specified Name.
IEnumSchematicDiagram	getSchematicDiagrams() Schematic diagrams enumeration within the schematic dataset or schematic folder container.
ISchematicLayer	getSchematicLayerTemplate() Schematic layer template related to the schematic diagram class.
IEnumSchematicAlgorithm	getSchematicTraces() Schematic analyst traces of the schematic diagram class.
boolean	isAlwaysLoadDiagrams() Indicates if the diagrams which belong to the diagram class are always loaded.
boolean	isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass) Indicates whether or not the element class is associated to the schematic diagram class.
ISchematicInMemoryDiagram	loadSchematicInMemoryDiagram(String diagramName) Loads a schematic in memory diagram specified by its DiagramName.
void	setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams) Indicates if the diagrams which belong to the diagram class are always loaded.
void	setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass) Default schematic in memory node element class related to the schematic diagram class.
void	setParentByRef(ISchematicDiagramClass parent) Parent of the schematic diagram class.
void	setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm) Schematic algorithm of the schematic diagram class.
void	setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms) Schematic algorithms of the schematic diagram class.
void	setSchematicBuilderByRef(ISchematicBuilder schematicBuilder) Schematic builder of the schematic diagram class.
void	setSchematicLayerTemplate(ISchematicLayer schematicLayer) Schematic layer template related to the schematic diagram class.
void	setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms) Schematic analyst traces of the schematic diagram 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

getParent

ISchematicDiagramClass getParent()
                                 throws IOException,
                                        AutomationException

Parent of the schematic diagram class.

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.

setParentByRef

void setParentByRef(ISchematicDiagramClass parent)
                    throws IOException,
                           AutomationException

Parent of the schematic diagram class.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedSchematicElementClasses

IEnumSchematicElementClass getAssociatedSchematicElementClasses()
                                                                throws IOException,
                                                                       AutomationException

The associated element classes to the schematic diagram class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

associateSchematicElementClass

void associateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                    throws IOException,
                                           AutomationException

Associates the element class to the schematic diagram class.

Product Availability

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

Parameters:

schematicElementClass - 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.

dissociateSchematicElementClass

void dissociateSchematicElementClass(ISchematicElementClass schematicElementClass)
                                     throws IOException,
                                            AutomationException

Dissociates the element class from the schematic diagram class.

Product Availability

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

Parameters:

schematicElementClass - 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.

isSchematicElementClassAssociated

boolean isSchematicElementClassAssociated(ISchematicElementClass schematicElementClass)
                                          throws IOException,
                                                 AutomationException

Indicates whether or not the element class is associated to the schematic diagram class.

Product Availability

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

Parameters:

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

Returns:

The isAssociated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicBuilder

ISchematicBuilder getSchematicBuilder()
                                      throws IOException,
                                             AutomationException

Schematic builder of the schematic diagram class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicBuilderByRef

void setSchematicBuilderByRef(ISchematicBuilder schematicBuilder)
                              throws IOException,
                                     AutomationException

Schematic builder of the schematic diagram class.

Product Availability

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

Parameters:

schematicBuilder - A reference to a com.esri.arcgis.schematic.ISchematicBuilder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicAlgorithm

ISchematicAlgorithm getSchematicAlgorithm()
                                          throws IOException,
                                                 AutomationException

Schematic algorithm of the schematic diagram class.

Product Availability

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

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.

setSchematicAlgorithmByRef

void setSchematicAlgorithmByRef(ISchematicAlgorithm schematicAlgorithm)
                                throws IOException,
                                       AutomationException

Schematic algorithm of the schematic diagram class.

Description

This is the algorithm which is automatically launched during the generation and update of the diagrams. This default schematic layout algorithm applies at the update when the updated diagram has no saved edits

Product Availability

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

Parameters:

schematicAlgorithm - 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.

getSchematicAlgorithms

IEnumSchematicAlgorithm getSchematicAlgorithms()
                                               throws IOException,
                                                      AutomationException

Schematic algorithms of the schematic diagram class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicAlgorithmsByRef

void setSchematicAlgorithmsByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                                 throws IOException,
                                        AutomationException

Schematic algorithms of the schematic diagram class.

Product Availability

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

Parameters:

schematicAlgorithms - A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicTraces

IEnumSchematicAlgorithm getSchematicTraces()
                                           throws IOException,
                                                  AutomationException

Schematic analyst traces of the schematic diagram class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicTracesByRef

void setSchematicTracesByRef(IEnumSchematicAlgorithm schematicAlgorithms)
                             throws IOException,
                                    AutomationException

Schematic analyst traces of the schematic diagram class.

Product Availability

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

Parameters:

schematicAlgorithms - A reference to a com.esri.arcgis.schematic.IEnumSchematicAlgorithm (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadSchematicInMemoryDiagram

ISchematicInMemoryDiagram loadSchematicInMemoryDiagram(String diagramName)
                                                       throws IOException,
                                                              AutomationException

Loads a schematic in memory diagram specified by its DiagramName.

Product Availability

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

Parameters:

diagramName - The diagramName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlwaysLoadDiagrams

boolean isAlwaysLoadDiagrams()
                             throws IOException,
                                    AutomationException

Indicates if the diagrams which belong to the diagram class are always loaded.

Product Availability

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

Returns:

The alwaysLoadDiagrams

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlwaysLoadDiagrams

void setAlwaysLoadDiagrams(boolean alwaysLoadDiagrams)
                           throws IOException,
                                  AutomationException

Indicates if the diagrams which belong to the diagram class are always loaded.

Product Availability

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

Parameters:

alwaysLoadDiagrams - The alwaysLoadDiagrams (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicLayerTemplate

void setSchematicLayerTemplate(ISchematicLayer schematicLayer)
                               throws IOException,
                                      AutomationException

Schematic layer template related to the schematic diagram class.

Description

This is the set of layer properties that define the representation of feature layers that compose the schematic diagrams based on the diagram class.

Product Availability

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

Parameters:

schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicLayerTemplate

ISchematicLayer getSchematicLayerTemplate()
                                          throws IOException,
                                                 AutomationException

Schematic layer template related to the schematic diagram class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSchematicNodeClass

void setDefaultSchematicNodeClass(ISchematicElementClass schematicElementClass)
                                  throws IOException,
                                         AutomationException

Default schematic in memory node element class related to the schematic diagram class.

Description

When the origin and/or end nodes for the links are missing, the schematic links in the diagrams may start/end with no extremity nodes. Specifying the DefaultSchematicNodeClass allows you to avoid these potential missing nodes; default extremity nodes based on this schematic node class will be automatically added at the end of the links when needed.

Product Availability

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

Parameters:

schematicElementClass - 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.

getDefaultSchematicNodeClass

ISchematicElementClass getDefaultSchematicNodeClass()
                                                    throws IOException,
                                                           AutomationException

Default schematic in memory node element class related to the schematic diagram 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.

createSchematicDiagram

ISchematicDiagram createSchematicDiagram(String name,
                                         ISchematicDiagramContainer diagramContainer)
                                         throws IOException,
                                                AutomationException

Creates a new schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (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.

getSchematicDiagrams

IEnumSchematicDiagram getSchematicDiagrams()
                                           throws IOException,
                                                  AutomationException

Schematic diagrams enumeration within the schematic dataset or schematic folder container.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByID

ISchematicDiagram getSchematicDiagramByID(int iD)
                                          throws IOException,
                                                 AutomationException

Schematic diagram referenced by the specified ID.

Product Availability

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

Parameters:

iD - The iD (in)

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.

getSchematicDiagramByName

ISchematicDiagram getSchematicDiagramByName(String name)
                                            throws IOException,
                                                   AutomationException

Schematic diagram referenced by the specified Name.

Product Availability

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

Parameters:

name - The name (in)

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.