com.esri.arcgis.networkanalyst
Class NAServerLP

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAServerLP
All Implemented Interfaces:
IAGSServerObject, IAGSServerObject2, com.esri.arcgis.interop.RemoteObjRef, INAServer, ISupportErrorInfo, Serializable

public class NAServerLP
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObject2, IAGSServerObject, INAServer, ISupportErrorInfo

NAServer Proxy for LAN messages.

Remarks

NAServerLP is used by GISClient to access the NAServer MapServer object extension to perform network analysis in a stateless environment over a LAN.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NAServerLP()
          Constructs a NAServerLP using ArcGIS Engine.
NAServerLP(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerLP theNAServerLP = (NAServerLP) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IName getFullName()
          The AGSServerConnectionName object associated with the server object.
 int getHttpTimeout()
          The maximum time in seconds to wait for a response from the server (Internet only).
 String[] getNALayerNames(int layerType)
          Array of network analysis layers of a particular analysis type.
 INAServerNetworkDescription getNetworkDescription(String nALayerName)
          Network Dataset DataElement.
 INAServerSolverParams getSolverParameters(String nALayerName)
          Default solver parameters for the specified network analysis layer.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void setHttpTimeout(int secs)
          The maximum time in seconds to wait for a response from the server (Internet only).
 INAServerSolverResults solve(INAServerSolverParams nAServerSolverParams)
          Perform network analysis based on the input solve parameters.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

NAServerLP

public NAServerLP()
           throws IOException,
                  UnknownHostException
Constructs a NAServerLP using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NAServerLP

public NAServerLP(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerLP theNAServerLP = (NAServerLP) obj;

Construct a NAServerLP using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAServerLP.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException
The AGSServerConnectionName object associated with the server object.

Product Availability

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

Specified by:
getFullName in interface IAGSServerObject2
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHttpTimeout

public void setHttpTimeout(int secs)
                    throws IOException,
                           AutomationException
The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:
setHttpTimeout in interface IAGSServerObject2
Parameters:
secs - The secs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHttpTimeout

public int getHttpTimeout()
                   throws IOException,
                          AutomationException
The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:
getHttpTimeout in interface IAGSServerObject2
Returns:
The secs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNALayerNames

public String[] getNALayerNames(int layerType)
                         throws IOException,
                                AutomationException
Array of network analysis layers of a particular analysis type.

Remarks

GetNALayerNames returns an array of names of NALayers of a given type. For example, you could use this method to find the names of all of the route analysis layers in the default map of the map server.

Product Availability

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

Specified by:
getNALayerNames in interface INAServer
Parameters:
layerType - A com.esri.arcgis.networkanalyst.esriNAServerLayerType constant (in)
Returns:
The nALayerNames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNetworkDescription

public INAServerNetworkDescription getNetworkDescription(String nALayerName)
                                                  throws IOException,
                                                         AutomationException
Network Dataset DataElement.

Remarks

GetNetworkDescription returns an NAServerNetworkDescription object that allows you to retrieve things like the name of the network dataset as well as the sources and attributes within the network dataset.

Product Availability

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

Specified by:
getNetworkDescription in interface INAServer
Parameters:
nALayerName - The nALayerName (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAServerNetworkDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSolverParameters

public INAServerSolverParams getSolverParameters(String nALayerName)
                                          throws IOException,
                                                 AutomationException
Default solver parameters for the specified network analysis layer.

Remarks

GetSolverParameters returns the NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams) corresponding to the NALayer name passed in. The parameter object returned will have defaults based on the NALayer it is referencing.

You can pass this resulting object into the Solve method on INAServer to perform network analysis.

Product Availability

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

Specified by:
getSolverParameters in interface INAServer
Parameters:
nALayerName - The nALayerName (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAServerSolverParams
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

solve

public INAServerSolverResults solve(INAServerSolverParams nAServerSolverParams)
                             throws IOException,
                                    AutomationException
Perform network analysis based on the input solve parameters.

Remarks

Solve performs network analysis based on the NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams) that was passed in and returns it's output through an NAServerSolverResults object (NAServerRouteResults, NAServerClosestFacilityResults, NAServerServiceAreaParams).

Product Availability

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

Specified by:
solve in interface INAServer
Parameters:
nAServerSolverParams - A reference to a com.esri.arcgis.networkanalyst.INAServerSolverParams (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAServerSolverResults
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.