com.esri.arcgis.networkanalyst
Interface INAServerDataLayer

All Superinterfaces:

INAServerLocations, Serializable

All Known Implementing Classes:

NAServerDataLayer

public interface INAServerDataLayer
extends INAServerLocations, Serializable

Provides access to a data layer containing network locations.

Remarks

The INAServerDataLayer interface provides access to a feature layer in the associated map service to load as network locations into an input network analysis class.

The NAServerDataLayer object that implements this interface can be passed in to any of the properties of the NAServerSolverParams objects that expect an INAServerLocations interface pointer. For example, Stops, Barriers, Facilities, or Incidents.

If the data layer contains the network location fields "SourceID" (int), "SourceOID" (int), "PosAlong" (double), and "SideOfEdge" (int) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be in the data layer may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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

Method Summary

String	getDataLayerName() The name of the layer in the map.
IQueryFilter	getQueryFilter() The query filter used to constrain the search.
void	setDataLayerName(String pValue) The name of the layer in the map.
void	setQueryFilterByRef(IQueryFilter ppValue) The query filter used to constrain the search.

Method Detail

getDataLayerName

String getDataLayerName()
                        throws IOException,
                               AutomationException

The name of the layer in the map.

Remarks

DataLayerName specifies the name of a data layer in the associate map service to load as network locations.

Product Availability

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

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataLayerName

void setDataLayerName(String pValue)
                      throws IOException,
                             AutomationException

The name of the layer in the map.

Remarks

DataLayerName specifies the name of a data layer in the associate map service to load as network locations.

Product Availability

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

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

The query filter used to constrain the search.

Remarks

QueryFilter specifies an instance of QueryFilter or SpatialFilter used to constrain the input features.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

void setQueryFilterByRef(IQueryFilter ppValue)
                         throws IOException,
                                AutomationException

The query filter used to constrain the search.

Remarks

QueryFilter specifies an instance of QueryFilter or SpatialFilter used to constrain the input features.

Product Availability

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

Parameters:

ppValue - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.