com.esri.arcgis.geodatabase
Interface INetworkUpdate

All Superinterfaces:

Serializable

All Known Implementing Classes:

INetworkUpdateProxy, StreetNetwork, UtilityNetwork

public interface INetworkUpdate
extends Serializable

Provides access to members that start and end sessions for updating the attributes, schema, and topology of the network.

When To Use

Use the INetworkUpdate interface when you want to update the schema, attributes, or topology of a logical network. An updating session must be in progress in order to update the network. An updating session can be started by calling one of the StartXXXUpdating methods on the INetworkUpdate interface. For instance, to edit the attributes (disabled state or a weight value) of the network, it is necessary to execute the StartAttributesUpdating method.

This interface is designed specifically for the editing of a stand-alone logical network, a logical network that does not have an associated geometric network. It is imperative that if you have a geometric network, the logical network must be edited through its associated geometric network. You risk data corruption if you use the INetworkUpdate interface on logical networks that have an associated geometric network.

When working with a versioned network, updates to the logical network must also be done within an workspace edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing.

When doing any type of editing operation with networks you must always start the operation by calling one of the start methods and ending the operation by calling the corresponding stop method.

Product Availability

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

See Also:

INetworkUpdate, IForwardStar, IGraph, INetworkClass.getNetworkAncillaryRole(), INetworkWorkspace, INetworkClass.getGeometricNetwork(), INetworkClass.getFieldToWeightMapping(int), IUtilityNetwork, INetwork

Method Summary

boolean	isAttributesBeingUpdated() Indicates if the attributes of the network are currently being updated.
boolean	isSchemaBeingUpdated() Indicates if the schema of the network is currently being updated.
boolean	isTopologyBeingUpdated() Indicates if the topology of the network is currently being updated.
void	startAttributesUpdating() Starts a session for updating the attributes of the network.
void	startSchemaUpdating() Starts a session for updating the schema of the network.
void	startTopologyUpdating() Starts a session for updating the topology of the network.
void	stopAttributesUpdating() Ends the session for updating the attributes of the network.
void	stopSchemaUpdating() Ends the session for updating the schema for the network.
void	stopTopologyUpdating() Ends the session for updating the topology of the network.

Method Detail

startSchemaUpdating

void startSchemaUpdating()
                         throws IOException,
                                AutomationException

Starts a session for updating the schema of the network.

Remarks

Starts updating of the network schema. This updating session must be open before calling any methods on the INetSchemaEdit interface.

If you run StartSchemaUpdating to begin an updating session, then be sure to run StopSchemaUpdating when you have finished updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopSchemaUpdating

void stopSchemaUpdating()
                        throws IOException,
                               AutomationException

Ends the session for updating the schema for the network.

Remarks

StopSchemaUpdating is run to close an updating session on the schema that started with StartSchemaUpdating. Do not run this method if you did not begin editing the schema by executing StartSchemaUpdating. Methods in the INetSchemaEdit interface can not be executed once StopSchemaUpdating has been executed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSchemaBeingUpdated

boolean isSchemaBeingUpdated()
                             throws IOException,
                                    AutomationException

Indicates if the schema of the network is currently being updated.

Remarks

IsSchemaBeingUpdated identifies whether there is an open updating session on the schema. This updating session is necessary to execute the methods in INetSchemaEdit and can be opened by executing the StartSchemaUpdating method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bIsSchemaBeingUpdated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startTopologyUpdating

void startTopologyUpdating()
                           throws IOException,
                                  AutomationException

Starts a session for updating the topology of the network.

Remarks

Starts updating of the network topology. This updating session must be open before calling any methods on the INetTopologyEdit interface.

If you run StartTopologyUpdating to begin an updating session, then be sure to run StopTopologyUpdating when you have finished updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopTopologyUpdating

void stopTopologyUpdating()
                          throws IOException,
                                 AutomationException

Ends the session for updating the topology of the network.

Remarks

StopTopologyUpdating is run to close an updating session on the topology that started with StartTopologyUpdating. Do not run this method if you did not begin updating the topology by executing StartTopologyUpdating. Methods in the INetTopologyEdit interface can not be executed once StopTopologyUpdating has been executed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTopologyBeingUpdated

boolean isTopologyBeingUpdated()
                               throws IOException,
                                      AutomationException

Indicates if the topology of the network is currently being updated.

Remarks

IsTopologyBeingUpdated identifies whether there is an open updating session on the topology of a logical network. This updating session is necessary to execute the methods in INetTopologyEdit and can be opened by executing the StartTopologyUpdating method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bIsTopologyBeingUpdated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startAttributesUpdating

void startAttributesUpdating()
                             throws IOException,
                                    AutomationException

Starts a session for updating the attributes of the network.

Remarks

Starts updating of the network attributes. This updating session must be open before calling any methods on the INetAttributesEdit interface.

If you run StartAttributesUpdating to begin an updating session, then be sure to run StopAttributesUpdating when you have finished updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopAttributesUpdating

void stopAttributesUpdating()
                            throws IOException,
                                   AutomationException

Ends the session for updating the attributes of the network.

Remarks

StopAttributesUpdating is run to close an updating session on the attributes that started with StartAttributesUpdating. Do not run this method if you did not begin updating the attributes by executing StartAttributesUpdating. Methods in the INetAttributesEdit interface can not be executed once StopAttributesUpdating has been executed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAttributesBeingUpdated

boolean isAttributesBeingUpdated()
                                 throws IOException,
                                        AutomationException

Indicates if the attributes of the network are currently being updated.

Remarks

IsAttributesBeingUpdated identifies whether there is an open updating session on the attrbiutes of a logical network. This updating session is necessary to execute the methods in INetAttributesEdit and can be opened by executing the StartAttributesUpdating method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bIsAttributesBeingUpdated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.