com.esri.arcgis.networkanalyst
Class NALocationRanges

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INALocationRanges, IDocumentVersionSupportGEN, IPersist, IPersistStream, Externalizable, Serializable

public class NALocationRanges
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INALocationRanges, IPersistStream, IDocumentVersionSupportGEN, Externalizable

Defines the set of element positions to be associated with an analysis object.

Remarks

An NALocationRanges object specifies a set of junctions and ranges along edges.

NALocationRanges objects can be CoCreated, retrieved from an NALocationRangesObject object or NALocationRangesFeature object by getting the NALocationRanges property on the INALocationRangesObject interface, or retrieved through the NALocator object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NALocationRanges()
Constructs a NALocationRanges using ArcGIS Engine.

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

Method Summary

void	addEdgeRange(int edgeEID, int direction, double fromPosition, double toPosition) Adds an edge EID, as well as the direction and the specified range of positions along that edge, to the NALocationRanges object.
void	addJunction(int junctionEID) Adds a junction EID to the NALocationRanges object.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getEdgeRangeCount() Returns the number of edge ranges currently stored in the NALocationRanges object.
int	getJunctionCount() Returns the number of junction EIDs currently stored in the NALocationRanges object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	queryEdgeRange(int index, int[] edgeEID, int[] direction, double[] fromPosition, double[] toPosition) Retrieves the edge EID, along with the direction and the range of positions along that edge, stored at the specified index in the NALocationRanges object.
void	queryJunction(int index, int[] junctionEID) Retrieves the junction EID stored at the specified index in the NALocationRanges object.
void	readExternal(ObjectInput in)
void	removeAll() Removes all junction and edge information currently stored in the NALocationRanges object.
void	save(IStream pstm, int fClearDirty) save
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

NALocationRanges

public NALocationRanges()
                 throws IOException,
                        UnknownHostException

Constructs a NALocationRanges using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NALocationRanges

public NALocationRanges(Object obj)
                 throws IOException

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

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

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

getJunctionCount

public int getJunctionCount()
                     throws IOException,
                            AutomationException

Returns the number of junction EIDs currently stored in the NALocationRanges object.

Remarks

Provides a count of the junction EIDs held by the NALocationRanges object.

Product Availability

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

Specified by:

getJunctionCount in interface INALocationRanges

Returns:

The junctionCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addJunction

public void addJunction(int junctionEID)
                 throws IOException,
                        AutomationException

Adds a junction EID to the NALocationRanges object.

Remarks

Adds a junction EID to the set held by the NALocationRanges object.

Product Availability

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

Specified by:

addJunction in interface INALocationRanges

Parameters:

junctionEID - The junctionEID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryJunction

public void queryJunction(int index,
                          int[] junctionEID)
                   throws IOException,
                          AutomationException

Retrieves the junction EID stored at the specified index in the NALocationRanges object.

Remarks

Retrieves by index one of the junction EIDs held by the NALocationRanges object.

Product Availability

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

Specified by:

queryJunction in interface INALocationRanges

Parameters:

index - The index (in)

junctionEID - The junctionEID (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEdgeRangeCount

public int getEdgeRangeCount()
                      throws IOException,
                             AutomationException

Returns the number of edge ranges currently stored in the NALocationRanges object.

Remarks

Provides a count of the edge EIDs held by the NALocationRanges object.

Product Availability

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

Specified by:

getEdgeRangeCount in interface INALocationRanges

Returns:

The edgeRangeCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addEdgeRange

public void addEdgeRange(int edgeEID,
                         int direction,
                         double fromPosition,
                         double toPosition)
                  throws IOException,
                         AutomationException

Adds an edge EID, as well as the direction and the specified range of positions along that edge, to the NALocationRanges object.

Remarks

Adds an edge EID, as well as the direction and the specified range along that edge, to the set held by the NALocationRanges object.

Product Availability

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

Specified by:

addEdgeRange in interface INALocationRanges

Parameters:

edgeEID - The edgeEID (in)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in)

fromPosition - The fromPosition (in)

toPosition - The toPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryEdgeRange

public void queryEdgeRange(int index,
                           int[] edgeEID,
                           int[] direction,
                           double[] fromPosition,
                           double[] toPosition)
                    throws IOException,
                           AutomationException

Retrieves the edge EID, along with the direction and the range of positions along that edge, stored at the specified index in the NALocationRanges object.

Remarks

Retrieves by index one of the edge EIDs, along with the direction and the range along that edge, held by the NALocationRanges object.

Product Availability

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

Specified by:

queryEdgeRange in interface INALocationRanges

Parameters:

index - The index (in)

edgeEID - The edgeEID (in/out: use single element array)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in/out: use single element array)

fromPosition - The fromPosition (in/out: use single element array)

toPosition - The toPosition (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all junction and edge information currently stored in the NALocationRanges object.

Remarks

Removes all elements from the set of edge and junction EIDs held by the NALocationRanges object.

Product Availability

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

Specified by:

removeAll in interface INALocationRanges

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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