com.esri.arcgis.geodatabase
Interface INetwork

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IStreetNetwork, IUtilityNetwork, IUtilityNetwork2, IUtilityNetworkGEN

All Known Implementing Classes:

INetworkProxy, IStreetNetworkProxy, IUtilityNetwork2Proxy, IUtilityNetworkGENProxy, IUtilityNetworkProxy, StreetNetwork, UtilityNetwork

public interface INetwork

extends java.io.Serializable

Provides access to members that give general information about the network and its elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

Use the INetwork interface when you want to query the network for general information such as the status of the network or the number of edges in your network. You can also use this interface to create a forwardstar object, which is used for traversing the network.

Remarks

To obtain a reference to the logical network of a geometric network you first need to obtain a reference to the geometric network. An example of this can be found in the help for IGeometricNetwork.

Once you have a reference to the geometric network you can obtain a reference to the logical network using the IGeometricNetwork::Network property.

The INetwork interface is on the Network abstract class, which contains other interfaces for use with logical networks:

INetworkUpdate - Used for starting updating sessions in the logical network.
INetElements - Used for getting element ID's (EID's) and verify valid elements.
INetSchema - Used for getting element classes and in a logical network.
INetSchemaEdit - Used for editing the schema of the logical network such as adding weights.
INetAttributes - Used for getting weight values and enabled/disabled state of elements.
INetAttributesEdit - Used for changing weight values and disabled/enabling elements.
INetTopology - Used for seeing what elements are connect to another element.
INetTopologyEdit - Used for adding and deleting elements from the logical network.

Method Summary

IForwardStar	createForwardStar(boolean honorState, INetWeight junctionWeight, INetWeight fromToEdgeWeight, INetWeight toFromEdgeWeight, INetWeight turnWeight) Creates a forward star cursor on the network index.
IEnumNetEID	createNetBrowser(int elementType) Creates a network index element browser.
int	getEdgeCount() Number of edges in the network.
int	getJunctionCount() Number of junctions in the network.
int	getMaxDegree() Maximum degree of a junction.
int	getMaxTurn() Maximum number of turns associated with a junction.
int	getStatus() Status of the network.
int	getTurnCount() Number of turns in the network.

Method Detail

getStatus

public int getStatus()
              throws java.io.IOException,
                     AutomationException

Status of the network.

Supported Platforms

Windows, Solaris, Linux

Remarks

The status of a network can be:

esriNSInvalidConnection
esriNSNetworkAlreadyExist
esriNSReadOnlyNetwork
esriNSCannotOpenTables
esriNSCannotCreateTables
esriNSInvalidElementClasses
esriNSInvalidWeights
esriNSUnknownStatus
esriNSValidNetwork

Returns:

A com.esri.arcgis.geodatabase.esriNetworkStatus constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJunctionCount

public int getJunctionCount()
                     throws java.io.IOException,
                            AutomationException

Number of junctions in the network.

Supported Platforms

Windows, Solaris, Linux

Remarks

JunctionCount returns a count of all the junctions in the network.

Returns:

The junctionCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEdgeCount

public int getEdgeCount()
                 throws java.io.IOException,
                        AutomationException

Number of edges in the network.

Supported Platforms

Windows, Solaris, Linux

Remarks

EdgeCount returns a count of all the edges within the network.

Returns:

The edgeCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnCount

public int getTurnCount()
                 throws java.io.IOException,
                        AutomationException

Number of turns in the network.

Supported Platforms

Windows, Solaris, Linux

Remarks

TurnCount returns a count of all the turns within a StreetNetwork. For a UtilityNetwork, TurnCount will return 0.

Returns:

The turnCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxDegree

public int getMaxDegree()
                 throws java.io.IOException,
                        AutomationException

Maximum degree of a junction.

Supported Platforms

Windows, Solaris, Linux

Remarks

The MaxDegree is the maximum number of edges connected to any given junction in the network. This property can be used to determine if there are incorrect connections within the network. For instance, in a Gas Network it is unlikely that there would ever be more than 4 edges attached to a junction. If MaxDegree returned a number greater than 4, it would indicate a problem in the network.

Returns:

The maxDegree

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxTurn

public int getMaxTurn()
               throws java.io.IOException,
                      AutomationException

Maximum number of turns associated with a junction.

Supported Platforms

Windows, Solaris, Linux

Remarks

MaxTurn returns the maximum number of turns assigned to any given junction within a StreetNetwork. For a UtilityNetwork, MaxTurn will always return 0.

Returns:

The maxTurn

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createForwardStar

public IForwardStar createForwardStar(boolean honorState,
                                      INetWeight junctionWeight,
                                      INetWeight fromToEdgeWeight,
                                      INetWeight toFromEdgeWeight,
                                      INetWeight turnWeight)
                               throws java.io.IOException,
                                      AutomationException

Creates a forward star cursor on the network index.

Supported Platforms

Windows, Solaris, Linux

Remarks

CreateForwardStar generates an IForwardStar object that can be used for stepping through the network. The input parameters for the method are as follows:

HonorState refers to elements in your network that are enabled/disabled. If you set HonorState to True then the ForwardStar will only return elements that are not disabled. If you specify False then any element that is connected to the element you are accessing will return a ForwardStar.

Parameters:

honorState - The honorState (in)

junctionWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

fromToEdgeWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

toFromEdgeWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

turnWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IForwardStar

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createNetBrowser

public IEnumNetEID createNetBrowser(int elementType)
                             throws java.io.IOException,
                                    AutomationException

Creates a network index element browser.

Supported Platforms

Windows, Solaris, Linux

Remarks

CreateNetBrowser returns a reference to an IEnumNetEID interface. This particular enumeration represents all of the elements within the network. Use this method when you want to access all of the individual elements of the network for setting the enabled/disabled property or some other similar purpose.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumNetEID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.