com.esri.arcgis.networkanalysis
Class INetworkLoaderProgressProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.networkanalysis.INetworkLoaderProgressProxy

All Implemented Interfaces:

INetworkLoaderProgress, Externalizable, Serializable, EventListener

public class INetworkLoaderProgressProxy
extends com.esri.arcgis.interop.Dispatch
implements INetworkLoaderProgress, 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.

See Also:

INetworkLoader, INetworkLoaderProgress, INetworkLoaderProps, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	INetworkLoaderProgressProxy()
	INetworkLoaderProgressProxy(Object obj)
protected	INetworkLoaderProgressProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

INetworkLoaderProgressProxy

public INetworkLoaderProgressProxy()

INetworkLoaderProgressProxy

public INetworkLoaderProgressProxy(Object obj)
                            throws IOException

Throws:

IOException

INetworkLoaderProgressProxy

protected INetworkLoaderProgressProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

putMessage

public 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

Specified by:

putMessage in interface INetworkLoaderProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxFeatures

public 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

Specified by:

setMaxFeatures in interface INetworkLoaderProgress

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

public 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

Specified by:

setStepValue in interface INetworkLoaderProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public 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

Specified by:

step in interface INetworkLoaderProgress

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelled

public 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

Specified by:

isCancelled in interface INetworkLoaderProgress

Parameters:

theEvent - The event

Returns:

The pbIsCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.