com.esri.arcgis.networkanalyst
Class NAServerODCostMatrixResults

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

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

A container for the OD Cost Matrix network analysis results returned by NAServer.

Remarks

NAServerODCostMatrixResults returns the results of network analysis using the NAServer. What it contains depends on what was set on the NAServerODCostMatrixParams 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
NAServerODCostMatrixResults()
          Constructs a NAServerODCostMatrixResults using ArcGIS Engine.
NAServerODCostMatrixResults(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerODCostMatrixResults theNAServerODCostMatrixResults = (NAServerODCostMatrixResults) 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.
 String[] getCostAttributeNameIndex()
          Array of mappings of the cost attribute names into ODMatrix array index values.
 int[] getDestinationOIDIndex()
          Array of mappings of the Destination OIDs into ODMatrix array index values.
 IRecordSet getDestinations()
          RecordSet of Destinations 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 getODLines()
          RecordSet of ODRoutes returned from the network analysis.
 Object getODMatrix()
          3D array [origin, destination, cost] of OD-values returned from the network analysis.
 int[] getOriginOIDIndex()
          Array of mappings of the Origin OIDs into ODMatrix array index values.
 IRecordSet getOrigins()
          RecordSet of Origins 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.
 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.
 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

NAServerODCostMatrixResults

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

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

NAServerODCostMatrixResults

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

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

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.

getODLines

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

Remarks

ODLines contains the output line features between origins and destinations returned from the analysis.

Product Availability

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

Specified by:
getODLines in interface INAServerODCostMatrixResults
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.

getOrigins

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

Remarks

Origins returns an IRecordSet that holds the origins used during analysis.

Product Availability

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

Specified by:
getOrigins in interface INAServerODCostMatrixResults
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.

getDestinations

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

Remarks

Destinations returns an IRecordSet that holds the destinations used during analysis.

Product Availability

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

Specified by:
getDestinations in interface INAServerODCostMatrixResults
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 INAServerODCostMatrixResults
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 the polyline barriers used in the analysis.

Product Availability

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

Specified by:
getPolylineBarriers in interface INAServerODCostMatrixResults
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 the polygon barriers used in the analysis.

Product Availability

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

Specified by:
getPolygonBarriers in interface INAServerODCostMatrixResults
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.

getODMatrix

public Object getODMatrix()
                   throws IOException,
                          AutomationException
3D array [origin, destination, cost] of OD-values returned from the network analysis.

Remarks

ODMatrix contains an internal 3-dimensional array representing the ODMatrix.

Product Availability

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

Specified by:
getODMatrix in interface INAServerODCostMatrixResults
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginOIDIndex

public int[] getOriginOIDIndex()
                        throws IOException,
                               AutomationException
Array of mappings of the Origin OIDs into ODMatrix array index values.

Remarks

OriginOIDIndex contains an array that can be used to lookup the ObjectID in the origins RecordSet based on the index in the ODMatrix.

Product Availability

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

Specified by:
getOriginOIDIndex in interface INAServerODCostMatrixResults
Returns:
The originOIDIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationOIDIndex

public int[] getDestinationOIDIndex()
                             throws IOException,
                                    AutomationException
Array of mappings of the Destination OIDs into ODMatrix array index values.

Remarks

DestinationOIDIndex contains an array that can be used to lookup the ObjectID in the destinations RecordSet based on the index in the ODMatrix

Product Availability

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

Specified by:
getDestinationOIDIndex in interface INAServerODCostMatrixResults
Returns:
The destinationOIDIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCostAttributeNameIndex

public String[] getCostAttributeNameIndex()
                                   throws IOException,
                                          AutomationException
Array of mappings of the cost attribute names into ODMatrix array index values.

Remarks

CostAttributeNameIndex contains the array of cost attributes in the ODMatrix.

Product Availability

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

Specified by:
getCostAttributeNameIndex in interface INAServerODCostMatrixResults
Returns:
The costAttributeNameIndex
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