com.esri.arcgis.networkanalysis
Interface INetworkLoaderProgress

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
INetworkLoaderProgressAdapter, INetworkLoaderProgressProxy

public interface INetworkLoaderProgress
extends EventListener, Serializable

Provides access to events that occur when building a geometric network using a NetworkLoader object.

When To Use

The INetworkLoaderProgress interface can be used in conjunction with the NetworkLoader object to determine progress when building a network. This is particulary useful for extremely large datasets and building networks in SDE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
INetworkLoader, INetworkLoaderProgress, INetworkLoaderProps

Method Summary
 boolean isCancelled(INetworkLoaderProgressIsCancelledEvent theEvent)
          Indicates if the Cancel button has been pressed.
 void putMessage(INetworkLoaderProgressPutMessageEvent theEvent)
          Puts the fixed networkLoaderProgress message and the additional message to the progress bar.
 void setMaxFeatures(INetworkLoaderProgressSetMaxFeaturesEvent theEvent)
          Total number of features in the current task of building the geometric network.
 void setStepValue(INetworkLoaderProgressSetStepValueEvent theEvent)
          Number of features to be processed between updates of the progress bar.
 void step(INetworkLoaderProgressStepEvent theEvent)
          Updates the progress bar.
 

Method Detail

putMessage

void putMessage(INetworkLoaderProgressPutMessageEvent theEvent)
                throws IOException,
                       AutomationException
Puts the fixed networkLoaderProgress message and the additional message to the progress bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxFeatures

void setMaxFeatures(INetworkLoaderProgressSetMaxFeaturesEvent theEvent)
                    throws IOException,
                           AutomationException
Total number of features in the current task of building the geometric network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INetworkUpdate, IForwardStar, IGraph, INetworkClass.getNetworkAncillaryRole(), INetworkWorkspace, INetworkClass.getGeometricNetwork(), INetworkClass.getFieldToWeightMapping(int), IUtilityNetwork, INetwork

setStepValue

void setStepValue(INetworkLoaderProgressSetStepValueEvent theEvent)
                  throws IOException,
                         AutomationException
Number of features to be processed between updates of the progress bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

step

void step(INetworkLoaderProgressStepEvent theEvent)
          throws IOException,
                 AutomationException
Updates the progress bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCancelled

boolean isCancelled(INetworkLoaderProgressIsCancelledEvent theEvent)
                    throws IOException,
                           AutomationException
Indicates if the Cancel button has been pressed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
theEvent - The event
Returns:
The pbIsCancelled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.