com.esri.arcgis.networkanalyst
Class NAServerVRPResults

java.lang.Object
  com.esri.arcgis.networkanalyst.NAServerVRPResults

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAServerSolverResults, INAServerSolverResults2, INAServerVRPResults, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerVRPResults
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverResults, INAServerSolverResults2, INAServerVRPResults, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

Deprecated as of 10.0. A container for the Vehicle Routing Problem network analysis results returned by NAServer.

Remarks

At version 10.1, ArcGIS for Server no longer supports performing network analysis via local connections using the GISServer and GISClient APIs. Use the SOAP or REST API instead.

NAServerVRPResults returns the results of network analysis using the NAServer. What it contains depends on what was set on the NAServerVRPParams object that was passed into the Solve method on INAServer.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAServerVRPResults()
Constructs a NAServerVRPResults using ArcGIS Engine.

NAServerVRPResults(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerVRPResults theNAServerVRPResults = (NAServerVRPResults) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IRecordSet	getBarriers() RecordSet of Barriers returned from the network analysis.
IRecordSet	getBreaks() RecordSet of Breaks returned from the network analysis.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
INACompactStreetDirections[]	getCompactDirections() Compact directions for each resulting routes.
IRecordSet	getDepots() RecordSet of Depots returned from the network analysis.
IRecordSet	getDepotVisits() RecordSet of Depot Visits returned from the network analysis.
String	getLayerToken() Token identifying of the network analysis layer saved on the server.
IMapImage	getMapImage() MapImage containing the network analysis result.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IRecordSet	getOrderPairs() RecordSet of OrderPairs returned from the network analysis.
IRecordSet	getOrders() RecordSet of Orders returned from the network analysis.
IRecordSet	getPolygonBarriers() RecordSet of Polygon Barriers returned from the network analysis.
IRecordSet	getPolylineBarriers() RecordSet of Polyline Barriers returned from the network analysis.
IRecordSet	getRouteRenewals() RecordSet of Route Renewals returned from the network analysis.
IRecordSet	getRoutes() RecordSet of Routes returned from the network analysis.
IRecordSet	getRouteSeedPoints() RecordSet of Route Seed Points returned from the network analysis.
IRecordSet	getRouteZones() RecordSet of Route Zones returned from the network analysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSolveErrorCode() Error code returned by solve operation if it failed.
IGPMessages	getSolveMessages() Error and warning messages returned by the network analysis solver.
IRecordSet	getSpecialties() RecordSet of Specialties returned from the network analysis.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	writeExternal(ObjectOutput out)

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

NAServerVRPResults

public NAServerVRPResults()
                   throws IOException,
                          UnknownHostException

Constructs a NAServerVRPResults using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAServerVRPResults

public NAServerVRPResults(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerVRPResults theNAServerVRPResults = (NAServerVRPResults) obj;

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

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

getMapImage

public IMapImage getMapImage()
                      throws IOException,
                             AutomationException

MapImage containing the network analysis result.

Remarks

MapImage returns the image drawn during NAServer::Solve using the NAServerSolverParams::MapDescription and NAServerSolverParams::ImageDescription properties.

Product Availability

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

Specified by:

getMapImage in interface INAServerSolverResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSolveMessages

public IGPMessages getSolveMessages()
                             throws IOException,
                                    AutomationException

Error and warning messages returned by the network analysis solver.

Remarks

SolverMessages returns an IGPMessages interface pointer to a GPMessages object that contains informational messages that were generated during NAServer::Solve.

Product Availability

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

Specified by:

getSolveMessages in interface INAServerSolverResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSolveErrorCode

public int getSolveErrorCode()
                      throws IOException,
                             AutomationException

Error code returned by solve operation if it failed.

Remarks

SolveErrorCode contains returned error code, if NAServerSolverParams.ReturnPartialResultsOnError was True and Solve failed.

Product Availability

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

Specified by:

getSolveErrorCode in interface INAServerSolverResults2

Returns:

The errorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerToken

public String getLayerToken()
                     throws IOException,
                            AutomationException

Token identifying of the network analysis layer saved on the server.

Remarks

LayerToken contains token to the network analysis layer saved on the server containing the results of the analsyis. This is only populated when NAServerSolverParams.SaveLayerOnServer was set to True or NAServerSolverParams.LayerToken was populated with a valid value.

Product Availability

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

Specified by:

getLayerToken in interface INAServerSolverResults2

Returns:

The layerToken

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRoutes

public IRecordSet getRoutes()
                     throws IOException,
                            AutomationException

RecordSet of Routes returned from the network analysis.

Remarks

Routes contains output route features.

Product Availability

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

Specified by:

getRoutes in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderPairs

public IRecordSet getOrderPairs()
                         throws IOException,
                                AutomationException

RecordSet of OrderPairs returned from the network analysis.

Remarks

OrderPairs contains order pairs used in the analysis.

Product Availability

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

Specified by:

getOrderPairs in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrders

public IRecordSet getOrders()
                     throws IOException,
                            AutomationException

RecordSet of Orders returned from the network analysis.

Remarks

Orders contains orders used in the analysis.

Product Availability

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

Specified by:

getOrders in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepots

public IRecordSet getDepots()
                     throws IOException,
                            AutomationException

RecordSet of Depots returned from the network analysis.

Remarks

Depots contains depots used in the analysis.

Product Availability

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

Specified by:

getDepots in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepotVisits

public IRecordSet getDepotVisits()
                          throws IOException,
                                 AutomationException

RecordSet of Depot Visits returned from the network analysis.

Remarks

DepotVisits contains output depot visit features.

Product Availability

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

Specified by:

getDepotVisits in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreaks

public IRecordSet getBreaks()
                     throws IOException,
                            AutomationException

RecordSet of Breaks returned from the network analysis.

Remarks

Breaks contains output break features.

Product Availability

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

Specified by:

getBreaks in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteRenewals

public IRecordSet getRouteRenewals()
                            throws IOException,
                                   AutomationException

RecordSet of Route Renewals returned from the network analysis.

Remarks

RouteRenewals contains output route renewal features.

Product Availability

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

Specified by:

getRouteRenewals in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteSeedPoints

public IRecordSet getRouteSeedPoints()
                              throws IOException,
                                     AutomationException

RecordSet of Route Seed Points returned from the network analysis.

Remarks

RouteSeedPoints contains output route seed point features.

Product Availability

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

Specified by:

getRouteSeedPoints in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteZones

public IRecordSet getRouteZones()
                         throws IOException,
                                AutomationException

RecordSet of Route Zones returned from the network analysis.

Remarks

RouteZones contains route zone features used in the analysis.

Product Availability

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

Specified by:

getRouteZones in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecialties

public IRecordSet getSpecialties()
                          throws IOException,
                                 AutomationException

RecordSet of Specialties returned from the network analysis.

Remarks

Specialties contains specialties used in the analysis.

Product Availability

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

Specified by:

getSpecialties in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

public IRecordSet getBarriers()
                       throws IOException,
                              AutomationException

RecordSet of Barriers returned from the network analysis.

Remarks

Barriers returns an IRecordSet that holds the Barriers used during analysis.

Product Availability

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

Specified by:

getBarriers in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

public IRecordSet getPolylineBarriers()
                               throws IOException,
                                      AutomationException

RecordSet of Polyline Barriers returned from the network analysis.

Remarks

PolylineBarriers contains polyline barriers used in the analysis.

Product Availability

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

Specified by:

getPolylineBarriers in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

public IRecordSet getPolygonBarriers()
                              throws IOException,
                                     AutomationException

RecordSet of Polygon Barriers returned from the network analysis.

Remarks

PolygonBarriers contains polygon barriers used in the analysis.

Product Availability

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

Specified by:

getPolygonBarriers in interface INAServerVRPResults

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompactDirections

public INACompactStreetDirections[] getCompactDirections()
                                                  throws IOException,
                                                         AutomationException

Compact directions for each resulting routes.

Remarks

CompactDirections contains array of turn by turn compact directions for each route.

Product Availability

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

Specified by:

getCompactDirections in interface INAServerVRPResults

Returns:

A reference to a com.esri.arcgis.networkanalyst.INACompactStreetDirections array

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

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.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException