com.esri.arcgis.geodatabase
Interface IDENetworkDataset

All Superinterfaces:

Serializable

All Known Subinterfaces:

IDENetworkDataset2

All Known Implementing Classes:

DENetworkDataset

public interface IDENetworkDataset
extends Serializable

Provides access to members that describe network dataset data elements.

Remarks

The IDENetworkDataset interface should be used to access certain properties of the Network Dataset, such as Hierarchy information. The IDENetworkDataset interface in combination with the INetworkBuild::UpdateSchema method, should also be used for combining schema updates into a single operation, such as adding multiple sources or attributes to a network dataset. This is the same methodology that is used by the network dataset property page in ArcCatalog.

The access the data element for a network dataset, QI to the IDatasetComponent interface and use the DataElement method

Product Availability

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

Method Summary

IArray	getAttributes() Array of network attributes in this network dataset.
String	getConfigurationKeyword() The database configuration keyword for the network dataset.
INetworkDirections	getDirections() The driving directions settings for the network dataset.
INetworkAttribute	getHierarchyClusterAttribute() The network attribute that is used to optimize network building for hierarchical traversal.
int	getHierarchyLevelCount() The number of hierarchy levels in the network dataset.
int	getMaxValueForHierarchy(int level) The maximum value for the specified hierarchy level in the network dataset.
int	getNetworkType() The type of the network dataset.
IPropertySet	getProperties() Property set of this network dataset.
IArray	getSources() Array of network sources in this network dataset.
IPropertySet	getUserData() User specified property set of this network dataset.
boolean	isBuildable() Indicates if this network dataset is buildable.
boolean	isSupportsTurns() Indicates if this network dataset supports network turn elements.
void	setAttributesByRef(IArray attributes) Array of network attributes in this network dataset.
void	setBuildable(boolean supportsTurns) Indicates if this network dataset is buildable.
void	setConfigurationKeyword(String configKeyword) The database configuration keyword for the network dataset.
void	setDirectionsByRef(INetworkDirections directions) The driving directions settings for the network dataset.
void	setHierarchyClusterAttribute(INetworkAttribute attribute) The network attribute that is used to optimize network building for hierarchical traversal.
void	setHierarchyLevelCount(int count) The number of hierarchy levels in the network dataset.
void	setMaxValueForHierarchy(int level, int value) The maximum value for the specified hierarchy level in the network dataset.
void	setNetworkType(int type) The type of the network dataset.
void	setProperties(IPropertySet datasetProperties) Property set of this network dataset.
void	setSourcesByRef(IArray sources) Array of network sources in this network dataset.
void	setSupportsTurns(boolean supportsTurns) Indicates if this network dataset supports network turn elements.
void	setUserData(IPropertySet userProperties) User specified property set of this network dataset.

Method Detail

getNetworkType

int getNetworkType()
                   throws IOException,
                          AutomationException

The type of the network dataset.

Remarks

The NetworkType property returns 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.

setNetworkType

void setNetworkType(int type)
                    throws IOException,
                           AutomationException

The type of the network dataset.

Product Availability

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

Parameters:

type - A com.esri.arcgis.geodatabase.esriNetworkDatasetType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributes

IArray getAttributes()
                     throws IOException,
                            AutomationException

Array of network attributes in this network dataset.

Remarks

The Attributes property is used to set or get the collection of attributes associated with a network dataset. The Attributes property requires an IArray object which can be used to add, remove or iterate over the attributes.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributesByRef

void setAttributesByRef(IArray attributes)
                        throws IOException,
                               AutomationException

Array of network attributes in this network dataset.

Product Availability

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

Parameters:

attributes - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

String getConfigurationKeyword()
                               throws IOException,
                                      AutomationException

The database configuration keyword for the network dataset.

Remarks

If the network dataset has been created in a File or ArcSDE geodatabase, then you may specify a configuration keyword for building your network dataset. A configuration keyword is used to specify storage and location parameters for optimal space and disk location efficiency.

The configurationKeywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface. For more information on configuration keywords, refer to the ArcSDE documentation.

Product Availability

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

Returns:

The configKeyword

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

void setConfigurationKeyword(String configKeyword)
                             throws IOException,
                                    AutomationException

The database configuration keyword for the network dataset.

Product Availability

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

Parameters:

configKeyword - The configKeyword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSources

IArray getSources()
                  throws IOException,
                         AutomationException

Array of network sources in this network dataset.

Remarks

The Sources property is used to set or get the collection of sources associated with a network dataset. The Sources property requires an IArray object which can be used to add, remove or iterate over the attributes. Every network dataset has a system junction source; this source is added to the network dataset once the UpdateSchema method is called with the supplied data element. The system junction source is created once the first source is added to the network.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourcesByRef

void setSourcesByRef(IArray sources)
                     throws IOException,
                            AutomationException

Array of network sources in this network dataset.

Product Availability

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

Parameters:

sources - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirections

INetworkDirections getDirections()
                                 throws IOException,
                                        AutomationException

The driving directions settings for the network dataset.

Remarks

The Directions property is used to specify or return the Directions for the network dataset. The network dataset must have certain parameters in order to specify directions:

• There must be at least one edge source
• There must be a length attribute such with units such as Meters
• At least one edge source must have a text field. This is for the Primary Name property

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsByRef

void setDirectionsByRef(INetworkDirections directions)
                        throws IOException,
                               AutomationException

The driving directions settings for the network dataset.

Product Availability

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

Parameters:

directions - A reference to a com.esri.arcgis.geodatabase.INetworkDirections (in)

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.

Remarks

The SupportsTurns property indicates whether the network dataset can support turns. Once created, the turn support property of a network dataset cannot be changed. Specifying that a network dataset can support turns will allow Turn sources to be added to the network and also allow Turn evaluators to be added to the network dataset. This will allow evaluators such as “All left hand turns will take 15 seconds” to be specified.

If not set on the data element, the SupportsTurns property will default to True for shapefile and geodatabase networks.

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.

setSupportsTurns

void setSupportsTurns(boolean supportsTurns)
                      throws IOException,
                             AutomationException

Indicates if this network dataset supports network turn elements.

Product Availability

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

Parameters:

supportsTurns - The supportsTurns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildable

boolean isBuildable()
                    throws IOException,
                           AutomationException

Indicates if this network dataset is buildable.

Remarks

The Buildable property indicates whether the network dataset can be built with the INetworkBuild::BuildNetwork method. All shapefile and Geodatabase network datasets built through the Network Dataset Wizard will return a value of True. SDC based network datasets will return a value of False.

If not set on the data element, the Buildable property will default to True for shapefile and geodatabase networks.

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.

setBuildable

void setBuildable(boolean supportsTurns)
                  throws IOException,
                         AutomationException

Indicates if this network dataset is buildable.

Product Availability

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

Parameters:

supportsTurns - The supportsTurns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

IPropertySet getUserData()
                         throws IOException,
                                AutomationException

User specified property set of this network dataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserData

void setUserData(IPropertySet userProperties)
                 throws IOException,
                        AutomationException

User specified property set of this network dataset.

Product Availability

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

Parameters:

userProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

Property set of this network dataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperties

void setProperties(IPropertySet datasetProperties)
                   throws IOException,
                          AutomationException

Property set of this network dataset.

Product Availability

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

Parameters:

datasetProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyClusterAttribute

INetworkAttribute getHierarchyClusterAttribute()
                                               throws IOException,
                                                      AutomationException

The network attribute that is used to optimize network building for hierarchical traversal.

Remarks

The HierarchyClusterAttribute property is used to specify or return the attribute that will be used for specifying Hierarchy. The attribute must be of type esriNAUTHierarchy.

Product Availability

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

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.

setHierarchyClusterAttribute

void setHierarchyClusterAttribute(INetworkAttribute attribute)
                                  throws IOException,
                                         AutomationException

The network attribute that is used to optimize network building for hierarchical traversal.

Product Availability

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

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHierarchyLevelCount

void setHierarchyLevelCount(int count)
                            throws IOException,
                                   AutomationException

The number of hierarchy levels in the network dataset.

Remarks

The HierarchyLevelCount property is used to return the levels supported by the hierarchy attribute. By default this value is 3, since only 3 levels of hierarchy are supported on the network dataset.

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHierarchyLevelCount

int getHierarchyLevelCount()
                           throws IOException,
                                  AutomationException

The number of hierarchy levels 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.

setMaxValueForHierarchy

void setMaxValueForHierarchy(int level,
                             int value)
                             throws IOException,
                                    AutomationException

The maximum value for the specified hierarchy level in the network dataset.

Product Availability

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

Parameters:

level - The level (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

int getMaxValueForHierarchy(int level)
                            throws IOException,
                                   AutomationException

The maximum value for the specified hierarchy level in the network dataset.

Product Availability

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

Parameters:

level - The level (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.