com.esri.arcgis.networkanalyst
Class NAServerServiceAreaResults

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAServerServiceAreaResults
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INAServerServiceAreaResults, INAServerSolverResults, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerServiceAreaResults
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverResults, INAServerServiceAreaResults, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

A container for the service area network analysis results returned by NAServer.

Remarks

NAServerServiceAreaResults returns the results of network anlaysis using the NAServer. What it contains depends on what was set on the NAServerServiceAreaParams 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
NAServerServiceAreaResults()
          Constructs a NAServerServiceAreaResults using ArcGIS Engine.
NAServerServiceAreaResults(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerServiceAreaResults theNAServerServiceAreaResults = (NAServerServiceAreaResults) 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.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IRecordSet getFacilities()
          RecordSet of Facilities returned from the network analysis.
 IMapImage getMapImage()
          MapImage containing the network analysis result.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IPolyline[] getSALineGeometries()
          Polylines representing the edges traversed during network analysis.
 IRecordSet getSALines()
          RecordSet of SALines returned from the network analysis.
 IPolygon[] getSAPolygonGeometries()
          Polygons representing the areas traversed within the specified break times.
 IRecordSet getSAPolygons()
          RecordSet of SAPolygons returned from the network analysis.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IGPMessages getSolveMessages()
          Error and warning messages returned by the network analysis solver.
 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

NAServerServiceAreaResults

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

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

NAServerServiceAreaResults

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

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

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.

getSALineGeometries

public IPolyline[] getSALineGeometries()
                                throws IOException,
                                       AutomationException
Polylines representing the edges traversed during network analysis.

Remarks

SALineGeometries returns an array of Polyline geometries representing the streets traversed.

Product Availability

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

Specified by:
getSALineGeometries in interface INAServerServiceAreaResults
Returns:
A reference to a com.esri.arcgis.geometry.IPolyline array
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSALines

public IRecordSet getSALines()
                      throws IOException,
                             AutomationException
RecordSet of SALines returned from the network analysis.

Remarks

SALines returns an IRecordSet that holds the SALines found during analysis.

Product Availability

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

Specified by:
getSALines in interface INAServerServiceAreaResults
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.

getSAPolygonGeometries

public IPolygon[] getSAPolygonGeometries()
                                  throws IOException,
                                         AutomationException
Polygons representing the areas traversed within the specified break times.

Remarks

SAPolygonGeometries returns an array of Polygon geometries representing the area of the streets traversed.

Product Availability

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

Specified by:
getSAPolygonGeometries in interface INAServerServiceAreaResults
Returns:
A reference to a com.esri.arcgis.geometry.IPolygon array
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSAPolygons

public IRecordSet getSAPolygons()
                         throws IOException,
                                AutomationException
RecordSet of SAPolygons returned from the network analysis.

Remarks

SAPolygons returns an IRecordSet that holds the SAPolygons found during analysis.

Product Availability

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

Specified by:
getSAPolygons in interface INAServerServiceAreaResults
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.

getFacilities

public IRecordSet getFacilities()
                         throws IOException,
                                AutomationException
RecordSet of Facilities returned from the network analysis.

Remarks

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

Product Availability

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

Specified by:
getFacilities in interface INAServerServiceAreaResults
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 INAServerServiceAreaResults
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.

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