com.esri.arcgis.schematic
Interface INgDiagramType

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgDiagramTypeProxy, NgDiagramType

public interface INgDiagramType
extends Serializable

Provides access to members that control the graphic diagram type.

Description

A diagram type behaves as the template for the display properties of a network and is assigned to one project. Schematics elements are associated with diagram types and displayed in diagrams. More than one diagram type can be defined for a project. Typically, one diagram type is defined for a specific view of the network. For example, a diagram type is defined for a schematic of the electric network of primaries and switches, and a second diagram type is defined for a schematic of the internal schema (inside plant) of the devices.

Diagram types support parent–child relationships, allowing child diagram types to inherit the parameters set on the parent diagram type.

If you want to create a diagram type, you can use the ArcGIS Schematics Designer or call the esriSchematic CreateDiagramType method in your code.

You can complete your diagram definition by defining: the query returning all the diagrams of this type, the fields used to build up each diagram identifier for this diagram type, one or more attributes associated with this diagram type.

All these characteristics can be defined through the ArcGIS Schematics Designer, or program using the INgObjectType interface associated with your INgDiagramType.

Product Availability

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

See Also:
INgDiagram

Method Summary
 void associateElementType(INgElementType elementType)
          Associates the 'ElementType' element type with the diagram type.
 void delete(boolean deleteDescendants)
          Deletes the diagram type.
 void dissociateElementType(INgElementType elementType)
          Dissociates the 'ElementType' element type with the diagram type.
 INgDiagramTypes getAncestors()
          List of the ancestor diagram types for the diagram type.
 INgElementTypes getAssociatedElementTypes()
          List of the element types associated with the diagram type.
 INgDiagramTypes getChildren()
          List of the child diagram types for the diagram type.
 INgDiagramTypes getDescendants()
          List of the descendant diagram types for the diagram type.
 INgDiagram getDiagram(String diagramName)
          Returns the diagram named 'diagramName' implemented by the diagram type.
 INgNames getDiagramNames()
          List of the names of the diagrams implemented by the diagram type.
 INgDiagrams getDiagrams()
          List of diagrams implemented by the diagram type.
 String getName()
          Name of the diagram type.
 INgDiagramType getParent()
          Parent diagram type of the diagram type.
 boolean isElementTypeAssociated(INgElementType elementType)
          Indicates if the 'ElementType' element type is associated with the diagram type.
 INgDiagram openDiagram(String diagramName, boolean restore)
          Opens the diagram named 'diagramName' implemented by the diagram type.
 void setName(String pVal)
          Name of the diagram type.
 void setParent(INgDiagramType pVal)
          Parent diagram type of the diagram type.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the diagram type.

Description

This name is defined when the diagram type is created:

- either by calling the INgProjectBuilder CreateDiagramType method in the code,

- or when the diagram type is created through ArcGIS Schematics Designer.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the diagram type.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAssociatedElementTypes

INgElementTypes getAssociatedElementTypes()
                                          throws IOException,
                                                 AutomationException
List of the element types associated with the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgElementTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.associateElementType(com.esri.arcgis.schematic.INgElementType)

getDiagrams

INgDiagrams getDiagrams()
                        throws IOException,
                               AutomationException
List of diagrams implemented by the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiagrams
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDiagram

INgDiagram getDiagram(String diagramName)
                      throws IOException,
                             AutomationException
Returns the diagram named 'diagramName' implemented by the diagram type.

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.INgDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDiagram

INgDiagram openDiagram(String diagramName,
                       boolean restore)
                       throws IOException,
                              AutomationException
Opens the diagram named 'diagramName' implemented by the diagram type.

Description

Note that the diagramName parameter must be consistent with the diagram name identifier definition for its associated diagram type.

Remarks

Several Schematic event procedures are automatically chained during a diagram opening. For more details on these events' chaining, please see the Remarks section available from the INgDiagram Open method help-page.

Product Availability

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

Parameters:
diagramName - The diagramName (in)
restore - The restore (in, optional, pass true if not required)
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectEvents.beforeOpenDiagram(com.esri.arcgis.schematic.INgProjectEventsBeforeOpenDiagramEvent), INgProject.openDiagram(com.esri.arcgis.schematic.INgDiagramType, String, boolean), INgDiagram.open()

getParent

INgDiagramType getParent()
                         throws IOException,
                                AutomationException
Parent diagram type of the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getChildren(), INgDiagramType.getAncestors()

setParent

void setParent(INgDiagramType pVal)
               throws IOException,
                      AutomationException
Parent diagram type of the diagram type.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgDiagramType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAncestors

INgDiagramTypes getAncestors()
                             throws IOException,
                                    AutomationException
List of the ancestor diagram types for the diagram type.

Description

Note that the diagram type ancestors list is returned in ascending hierarchy order; that is from the parent to the most distant ancestor.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getParent(), INgDiagramType.getChildren()

getChildren

INgDiagramTypes getChildren()
                            throws IOException,
                                   AutomationException
List of the child diagram types for the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getParent(), INgDiagramType.getAncestors()

getDescendants

INgDiagramTypes getDescendants()
                               throws IOException,
                                      AutomationException
List of the descendant diagram types for the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getParent(), INgDiagramType.getChildren(), INgDiagramType.getAncestors()

delete

void delete(boolean deleteDescendants)
            throws IOException,
                   AutomationException
Deletes the diagram type. When setting the 'deleteDescendants' parameter to TRUE, all the diagram types that inherit from this diagram type are also deleted.

Description

Note that the TRUE value is the default value for the deleteDescendants parameter.

Product Availability

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

Parameters:
deleteDescendants - The deleteDescendants (in, optional, pass true if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDiagramNames

INgNames getDiagramNames()
                         throws IOException,
                                AutomationException
List of the names of the diagrams implemented by the diagram type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

associateElementType

void associateElementType(INgElementType elementType)
                          throws IOException,
                                 AutomationException
Associates the 'ElementType' element type with the diagram type.

Product Availability

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

Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getAssociatedElementTypes()

dissociateElementType

void dissociateElementType(INgElementType elementType)
                           throws IOException,
                                  AutomationException
Dissociates the 'ElementType' element type with the diagram type.

Product Availability

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

Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.associateElementType(com.esri.arcgis.schematic.INgElementType)

isElementTypeAssociated

boolean isElementTypeAssociated(INgElementType elementType)
                                throws IOException,
                                       AutomationException
Indicates if the 'ElementType' element type is associated with the diagram type.

Product Availability

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

Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Returns:
The isAssociated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.