com.esri.arcgis.geodatabase
Interface INetworkDataset

All Superinterfaces:
Serializable
All Known Implementing Classes:
INetworkDatasetProxy, NetworkDataset

public interface INetworkDataset
extends Serializable

Provides access to members that query the schema of the network dataset.

Remarks

A NetworkDataset is a collection of feature classes that participate in a network relationship. Each feature class has a topological role in the network and a network may have multiple feature classes in the same role. A feature dataset may have multiple networks but a feature class can only belong to one network, either a network dataset or geometric network. A Feature class in the network dataset is called a network source. Network datasets may also have attributes which are used for solving against a network dataset. Network dataset sources can also participate within a Topology.

The IDatasetContainer2 interface should be used for creating and opening network datasets. The INetworkBuild interface should be used for adding or removing sources or attributes from a network dataset and for building a network dataset.

Product Availability

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


Method Summary
 INetworkSource esri_getSource(int index)
          Network dataset source by index.
 INetworkAttribute getAttribute(int index)
          Network dataset attribute by index.
 INetworkAttribute getAttributeByID(int iD)
          Network dataset attribute corresponding to the specified ID.
 INetworkAttribute getAttributeByName(String name)
          Network dataset attribute corresponding to the specified name.
 int getAttributeCount()
          Number of attributes in the network dataset.
 int getNetworkType()
          The type of the network dataset.
 INetworkSource getSourceByID(int iD)
          Network dataset source corresponding to the specified ID.
 INetworkSource getSourceByName(String name)
          Network dataset source corresponding to the specified name.
 int getSourceCount()
          Number of sources in the network dataset.
 int getState()
          Indicates whether the network dataset is built or not.
 boolean isBuildable()
          Indicates if this network dataset is buildable.
 boolean isSupportsTurns()
          Indicates if this network dataset supports network turn elements.
 

Method Detail

isBuildable

boolean isBuildable()
                    throws IOException,
                           AutomationException
Indicates if this network dataset is buildable.

Remarks

Returns a boolean value indicating if the network dataset can be built using the INetworkBuild:BuildNetwork method. This method will return true for Geodatabase and Shapefile network datasets and false for SDC network datasets. Use the INetworkDataset:NetworkType property to determine the type of network dataset.

Product Availability

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

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

getNetworkType

int getNetworkType()
                   throws IOException,
                          AutomationException
The type of the network dataset.

Remarks

Returns the type of network dataset; geodatabase, shapefile, SDC or unknown. Use this property to handle properties that differ based on the type of network dataset.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriNetworkDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTurns

boolean isSupportsTurns()
                        throws IOException,
                               AutomationException
Indicates if this network dataset supports network turn elements.

Description

Returns a boolean value indicating if the network dataset supports turns. For shapefile and geodatabase networks, this property is set on the IDENetworkDataset interface of the data element. SDC based network datasets do not support turns.

Once a network dataset is created, turn support cannot be added. This can only be specified when the network is created.

Product Availability

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

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

getAttributeByID

INetworkAttribute getAttributeByID(int iD)
                                   throws IOException,
                                          AutomationException
Network dataset attribute corresponding to the specified ID.

Product Availability

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

Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeByName

INetworkAttribute getAttributeByName(String name)
                                     throws IOException,
                                            AutomationException
Network dataset attribute corresponding to the specified name.

Product Availability

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

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeCount

int getAttributeCount()
                      throws IOException,
                             AutomationException
Number of attributes in the network dataset.

Remarks

Returns the number of attributes assigned to the network dataset.

Product Availability

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

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

getAttribute

INetworkAttribute getAttribute(int index)
                               throws IOException,
                                      AutomationException
Network dataset attribute by index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceByID

INetworkSource getSourceByID(int iD)
                             throws IOException,
                                    AutomationException
Network dataset source corresponding to the specified ID.

Product Availability

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

Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceByName

INetworkSource getSourceByName(String name)
                               throws IOException,
                                      AutomationException
Network dataset source corresponding to the specified name.

Product Availability

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

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceCount

int getSourceCount()
                   throws IOException,
                          AutomationException
Number of sources in the network dataset.

Remarks

Returns the number of sources in the network dataset.

Product Availability

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

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

esri_getSource

INetworkSource esri_getSource(int index)
                              throws IOException,
                                     AutomationException
Network dataset source by index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

int getState()
             throws IOException,
                    AutomationException
Indicates whether the network dataset is built or not.

Remarks

The State property indicates the current status of the network dataset; whether the network dataset is unbuilt, built or empty. Network analysis may be performed on unbuilt network datasets, but the results cannot be guaranteed to be correct and will depend on the edits that have been made.

For network datasets in an ArcSDE geodatabase, the State property will return the error "Object does not support this action."

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriNetworkDatasetState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.