com.esri.arcgis.carto
Interface INetworkLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetworkLayer

public interface INetworkLayer
extends Serializable

Provides access to members that control a network layer.

Product Availability

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

Method Summary

void	expandRegionForSymbols(IDisplay display, IGeometry region) Expands the given geometry by an amount that will include the layer's symbology for the given display.
String	getDisplayAttribute() The primary display network attribute.
INetworkDataset	getNetworkDataset() The Network Dataset used to define the layer.
boolean	isScaleSymbols() Indicates if symbols are scaled for the layer.
IEnumLocatedNetworkElement	searchLocatedNetworkElements(String sourceName, IGeometry geometry) Searches through the specified network dataset's source and returns an enumeration of network locations that intersect the input geometry.
void	setDisplayAttribute(String attName) The primary display network attribute.
void	setNetworkDatasetByRef(INetworkDataset nds) The Network Dataset used to define the layer.
void	setScaleSymbols(boolean scale) Indicates if symbols are scaled for the layer.

Method Detail

getNetworkDataset

INetworkDataset getNetworkDataset()
                                  throws IOException,
                                         AutomationException

The Network Dataset used to define the layer.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNetworkDatasetByRef

void setNetworkDatasetByRef(INetworkDataset nds)
                            throws IOException,
                                   AutomationException

The Network Dataset used to define the layer.

Product Availability

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

Parameters:

nds - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayAttribute

String getDisplayAttribute()
                           throws IOException,
                                  AutomationException

The primary display network attribute.

Product Availability

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

Returns:

The attName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayAttribute

void setDisplayAttribute(String attName)
                         throws IOException,
                                AutomationException

The primary display network attribute.

Product Availability

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

Parameters:

attName - The attName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

boolean isScaleSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Product Availability

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

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

void expandRegionForSymbols(IDisplay display,
                            IGeometry region)
                            throws IOException,
                                   AutomationException

Expands the given geometry by an amount that will include the layer's symbology for the given display.

Product Availability

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

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

region - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchLocatedNetworkElements

IEnumLocatedNetworkElement searchLocatedNetworkElements(String sourceName,
                                                        IGeometry geometry)
                                                        throws IOException,
                                                               AutomationException

Searches through the specified network dataset's source and returns an enumeration of network locations that intersect the input geometry.

Product Availability

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

Parameters:

sourceName - The sourceName (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumLocatedNetworkElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.