Interface IDENetworkDataset

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to members that describe network dataset data elements.

[Guid("71E4AA21-1957-4224-B505-984C189AA520")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IDENetworkDataset

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

Properties

Attributes

Array of network attributes in this network dataset.

IArray Attributes { get; set; }

Property Value

IArray

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.

Buildable

Indicates if this network dataset is buildable.

bool Buildable { get; set; }

Property Value

bool

Remarks

The Buildable property indicates whether the network dataset can be built with the INetworkBuild.BuildNetwork method. If not set on the data element, the Buildable property will default to True.

ConfigurationKeyword

The database configuration keyword for the network dataset.

string ConfigurationKeyword { get; set; }

Property Value

string

Remarks

<p>Configuration keywords can be of two types:</p> <ul> <li>esriConfigurationKeywordGeneral, which references storage parameters for creating feature classes and tables</li> <li>esriConfigurationKeywordNetwork, which references storage parameters for creating geometric networks or network datasets</li> <li>esriConfigurationKeywordTopology, which references storage parameters for creating topologies</li> </ul> <p>An enumeration of <strong>ConfigurationKeyword</strong> objects for an ArcSDE or File geodatabase workspace is returned by the <strong>IWorkspaceConfiguration</strong> interface.</p>

DefaultTravelModeName

Name of default network travel mode for this network dataset.

string DefaultTravelModeName { get; set; }

Property Value

string

Directions

The directions settings for the network dataset.

INetworkDirections Directions { get; set; }

Property Value

INetworkDirections

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

ElevationModel

The type of the network elevation model.

esriNetworkElevationModel ElevationModel { get; set; }

Property Value

esriNetworkElevationModel

HierarchyClusterAttribute

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

INetworkAttribute HierarchyClusterAttribute { get; set; }

Property Value

INetworkAttribute

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.

HierarchyLevelCount

The number of hierarchy levels in the network dataset.

int HierarchyLevelCount { get; set; }

Property Value

int

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.

MaxValueForHierarchy[int]

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

int MaxValueForHierarchy[int Level] { get; set; }

Parameters

Level int

Property Value

int

Remarks

The MaxValueForHierarchy property is used to return the maximum value for each level of hierarchy for a network dataset. Since the network dataset only supports 3 levels of hierarchy, data that has more than 3 levels must have their hierarchy levels mapped to one of the three levels.

Unless explicitly specified, Shapefile and Geodatabase network datasets will return a value of 1, 2 and 2147483647 for hierarchy levels of one, two and three.

NetworkType

The type of the network dataset.

esriNetworkDatasetType NetworkType { get; set; }

Property Value

esriNetworkDatasetType

Remarks

The NetworkType property returns the type of network dataset.

Properties

Property set of this network dataset.

IPropertySet Properties { get; set; }

Property Value

IPropertySet

Sources

Array of network sources in this network dataset.

IArray Sources { get; set; }

Property Value

IArray

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.

SupportsTurns

Indicates if this network dataset supports network turn elements.

bool SupportsTurns { get; set; }

Property Value

bool

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.

TimeZoneAttributeName

Name of the time zone attribute.

string TimeZoneAttributeName { get; set; }

Property Value

string

TimeZoneTableName

Name of the time zone table.

string TimeZoneTableName { get; set; }

Property Value

string

TrafficData

Traffic data.

ITrafficData TrafficData { get; set; }

Property Value

ITrafficData

TransitData

The transit settings for the network dataset.

ITransitData TransitData { get; set; }

Property Value

ITransitData

TravelModes

Array of network travel modes in this network dataset.

IArray TravelModes { get; set; }

Property Value

IArray

UserData

User specified property set of this network dataset.

IPropertySet UserData { get; set; }

Property Value

IPropertySet