com.esri.arcgis.networkanalysis
Interface IEIDHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

EIDHelper

public interface IEIDHelper
extends Serializable

Provides access to members that get the features and/or geometries from an enumeration of element IDs.

Product Availability

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

Method Summary

void	addField(String field) Adds a field to the list of fields to return with the feature.
void	clearFields() Clears the list of fields to return with the feature.
IEnumEIDInfo	createEnumEIDInfo(IEnumNetEID netEIDs) Creates an enumeration of EIDInfo objects based on the specified EIDs and parameters on this EIDHelper object.
void	setDisplayEnvelopeByRef(IEnvelope rhs1) Envelope in which valid geometries and features must reside to be returned in the EnumEIDInfo object.
void	setGeometricNetworkByRef(IGeometricNetwork rhs1) Geometric network from which these element IDs come.
void	setOutputSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference the returned geometries should be in.
void	setPartialComplexEdgeGeometry(boolean rhs1) Indicates if the EIDs representing partial complex edges return the geometry of the partial complex edge.
void	setReturnFeatures(boolean rhs1) Indicates if the created IEIDInfo enumeration should contain features.
void	setReturnGeometries(boolean rhs1) Indicates if the created EIDInfo enumeration should contain geometries.

Method Detail

setGeometricNetworkByRef

void setGeometricNetworkByRef(IGeometricNetwork rhs1)
                              throws IOException,
                                     AutomationException

Geometric network from which these element IDs come.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IGeometricNetwork (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addField

void addField(String field)
              throws IOException,
                     AutomationException

Adds a field to the list of fields to return with the feature.

Remarks

Feature objects returned by this EIDHelper object are meant only for querying attribute values from the features and not for editing the features. These feature objects will only contain those fields specified using AddField. For optimization purposes, if no calls are made to AddField before calling CreateEnumEIDInfo, the feature objects returned will only contain the OID and Shape fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearFields

void clearFields()
                 throws IOException,
                        AutomationException

Clears the list of fields to return with the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnGeometries

void setReturnGeometries(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if the created EIDInfo enumeration should contain geometries.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnFeatures

void setReturnFeatures(boolean rhs1)
                       throws IOException,
                              AutomationException

Indicates if the created IEIDInfo enumeration should contain features.

Remarks

Feature objects returned by this EIDHelper object are meant only for querying attribute values from the features and not for editing the features. These feature objects will only contain those fields specified using AddField. For optimization purposes, if no calls are made to AddField before calling CreateEnumEIDInfo, the feature objects returned will only contain the OID and Shape fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

void setOutputSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws IOException,
                                           AutomationException

Spatial reference the returned geometries should be in.

Remarks

If the OutputSpatialReference property is set to Nothing, then each geometry is returned in the spatial reference of the corresponding source feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPartialComplexEdgeGeometry

void setPartialComplexEdgeGeometry(boolean rhs1)
                                   throws IOException,
                                          AutomationException

Indicates if the EIDs representing partial complex edges return the geometry of the partial complex edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createEnumEIDInfo

IEnumEIDInfo createEnumEIDInfo(IEnumNetEID netEIDs)
                               throws IOException,
                                      AutomationException

Creates an enumeration of EIDInfo objects based on the specified EIDs and parameters on this EIDHelper object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

netEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (in)

Returns:

A reference to a com.esri.arcgis.networkanalysis.IEnumEIDInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayEnvelopeByRef

void setDisplayEnvelopeByRef(IEnvelope rhs1)
                             throws IOException,
                                    AutomationException

Envelope in which valid geometries and features must reside to be returned in the EnumEIDInfo object.

Remarks

If the DisplayEnvelope property is set to null, then all features and/or geometries corresponding to the EIDs are returned, regardless of their spatial position.

If a DisplayEnvelope is specified, then only those features and geometries that intersect the specified envelope will be populated in the enumeration. Note that there will still be an EIDInfo object returned for every element in the network, but the Feature and Geometry properties on the IEIDInfo interface will return null for those elements that lie outside of the envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.