com.esri.arcgis.schematic
Interface ISchematicNetworkDatasetBuilder

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISchematicNetworkDatasetBuilderProxy

public interface ISchematicNetworkDatasetBuilder
extends Serializable

Provides access to members that control the schematic Network Dataset builder.

Description

The Schematic Network Dataset builder works from solver results on network datasets. It expects solved network analysis layers as input (such as solved route, service area, closest facility, or vehicle routing network task analysis).

Product Availability

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


Method Summary
 boolean isAutoCreateElementClasses()
          Indicates if the schematic element classes are automatically created by the schematic Network Dataset builder.
 boolean isInitializeLinksVertices()
          Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Network Dataset builder.
 boolean isMergeNodes()
          Indicates if the schematic Network Dataset builder generates only a schematic node per feature.
 boolean isPersistManualOperations()
          Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
 void setAutoCreateElementClasses(boolean autoCreate)
          Indicates if the schematic element classes are automatically created by the schematic Network Dataset builder.
 void setInitializeLinksVertices(boolean initializeLinksVertices)
          Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Network Dataset builder.
 void setMergeNodes(boolean mergeNodes)
          Indicates if the schematic Network Dataset builder generates only a schematic node per feature.
 void setPersistManualOperations(boolean persistManualOperations)
          Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
 

Method Detail

setAutoCreateElementClasses

void setAutoCreateElementClasses(boolean autoCreate)
                                 throws IOException,
                                        AutomationException
Indicates if the schematic element classes are automatically created by the schematic Network Dataset builder.

Description

When the AutoCreateElementClasses is enabled, schematic element classes related to the feature layers that compose the ArcGIS Network Analyst extension solved layer from which the Network Dataset builder operates are automatically created when they are missing.

Remarks

When the AutoCreateElementClasses is disabled, no new schematic element class is created when the Network Dataset builder operates. This means that if, for the schematic diagram class, there is no schematic element class associated with a particular feature layer that composes the ArcGIS Network Analyst extension solved layer on which the diagram generation is based, no schematic elements will be included in the generated diagram for the network elements in that particular feature layer.

Product Availability

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

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

isAutoCreateElementClasses

boolean isAutoCreateElementClasses()
                                   throws IOException,
                                          AutomationException
Indicates if the schematic element classes are automatically created by the schematic Network Dataset builder.

Product Availability

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

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

setInitializeLinksVertices

void setInitializeLinksVertices(boolean initializeLinksVertices)
                                throws IOException,
                                       AutomationException
Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Network Dataset builder.

Product Availability

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

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

isInitializeLinksVertices

boolean isInitializeLinksVertices()
                                  throws IOException,
                                         AutomationException
Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Network Dataset builder.

Product Availability

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

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

setPersistManualOperations

void setPersistManualOperations(boolean persistManualOperations)
                                throws IOException,
                                       AutomationException
Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.

Product Availability

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

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

isPersistManualOperations

boolean isPersistManualOperations()
                                  throws IOException,
                                         AutomationException
Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.

Product Availability

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

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

setMergeNodes

void setMergeNodes(boolean mergeNodes)
                   throws IOException,
                          AutomationException
Indicates if the schematic Network Dataset builder generates only a schematic node per feature.

Description

When MergeNodes is enabled, network element junctions which appear several times in the resultant network analysis are represented by a single schematic node in the generated schematic diagram.

When it is disabled, several schematic nodes are created in the generated schematic diagram to represent the same network element junction.

Product Availability

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

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

isMergeNodes

boolean isMergeNodes()
                     throws IOException,
                            AutomationException
Indicates if the schematic Network Dataset builder generates only a schematic node per feature.

Product Availability

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

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