com.esri.arcgis.networkanalyst
Interface INALayer

All Superinterfaces:

Serializable

All Known Subinterfaces:

INALayer2

All Known Implementing Classes:

NALayer

public interface INALayer
extends Serializable

Provides access to the network analysis layer.

Superseded By

INALayer2

Remarks

The INALayer interface is used to access the NAContext, access individual sublayers by specifying the name of the NAClass, and to manage the sublayers within the NALayer.

Product Availability

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

Method Summary

void	add(ILayer layer) Add a new layer.
void	clear() Clear all analysis layers.
void	delete(ILayer layer) Delete an existing layer.
INAContext	getContext() The network analysis context.
ILayer	getLayerByNAClassName(String name) The network analysis layer by class name.
boolean	isExpanded() Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.
void	setContextByRef(INAContext nAContext) The network analysis context.
void	setExpanded(boolean expanded) Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Method Detail

setContextByRef

void setContextByRef(INAContext nAContext)
                     throws IOException,
                            AutomationException

The network analysis context.

Remarks

Sets the NAContext associated with the NALayer. If this is done, it is also necessary to re-attach the sublayers to the NAClasses of the new NAContext as well.

Use INALayer2::AttachContext instead if you want to re-attach a context created with INALayer2::CopyContext since this will re-attach the sublayers for you.

Product Availability

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

Parameters:

nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContext

INAContext getContext()
                      throws IOException,
                             AutomationException

The network analysis context.

Remarks

Returns the NAContext associated with the NALayer.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerByNAClassName

ILayer getLayerByNAClassName(String name)
                             throws IOException,
                                    AutomationException

The network analysis layer by class 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.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(ILayer layer)
         throws IOException,
                AutomationException

Add a new layer.

Remarks

Adds a sublayer into the NALayer.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(ILayer layer)
            throws IOException,
                   AutomationException

Delete an existing layer.

Remarks

Removes a sublayer from the NALayer.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Clear all analysis layers.

Remarks

Removes all of the sublayers from the NALayer.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpanded

boolean isExpanded()
                   throws IOException,
                          AutomationException

Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Remarks

Specifies if the NALayer is expanded.

Product Availability

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

Returns:

The expanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpanded

void setExpanded(boolean expanded)
                 throws IOException,
                        AutomationException

Indicates if the network analysis layer is expanded or collapsed in the TOC of the map.

Remarks

Specifies if the NALayer is expanded.

Product Availability

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

Parameters:

expanded - The expanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.