com.esri.arcgis.geodatabase
Interface IEdgeFeatureSource

All Superinterfaces:

Serializable

All Known Implementing Classes:

EdgeFeatureSource

public interface IEdgeFeatureSource
extends Serializable

Provides access to members that specify the properties of a network dataset source whose edge elements are derived from line geometry.

Remarks

The IEdgeFeatureSource interface is used to access the properties of the edge feature source, such as its connectivity groups and elevation field names.

To access the EdgeFeatureSource object for an existing network dataset source, use the Source, SourceByID, or SourceByName methods on the INetworkDataset interface.

The IEdgeFeatureSource interface is also used to define a new edge feature source. To create a new edge feature source, cocreate the EdgeFeatureSource object, specify its properties on both the INetworkSource and IEdgeFeatureSource interfaces, and pass the object to the INetworkBuild::AddSource method on the network dataset.

Product Availability

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

Method Summary

int	getClassConnectivityGroup() Connectivity group in which this edge feature source participates.
int	getClassConnectivityPolicy() Policy determining how all edge elements in this source connect to each other.
String	getFromElevationFieldName() The field name on the feature source to be used as the from elevation field when determining connectivity at coincident end vertices.
int	getSubtypeConnectivityGroup(int subtypeCode) Connectivity group in which the specified subtype of this edge feature source participates.
int	getSubtypeConnectivityPolicy(int subtypeCode) Policy determining how the edge elements in the specified subtype of this source connect to each other.
String	getToElevationFieldName() The field name on the feature source to be used as the to elevation field when determining connectivity at coincident end vertices.
boolean	isUsesSubtypes() Indicates if this edge feature source determines connectivity groups and policies by subtypes.
void	setClassConnectivityGroup(int group) Connectivity group in which this edge feature source participates.
void	setClassConnectivityPolicy(int policy) Policy determining how all edge elements in this source connect to each other.
void	setFromElevationFieldName(String name) The field name on the feature source to be used as the from elevation field when determining connectivity at coincident end vertices.
void	setSubtypeConnectivityGroup(int subtypeCode, int group) Connectivity group in which the specified subtype of this edge feature source participates.
void	setSubtypeConnectivityPolicy(int subtypeCode, int policy) Policy determining how the edge elements in the specified subtype of this source connect to each other.
void	setToElevationFieldName(String name) The field name on the feature source to be used as the to elevation field when determining connectivity at coincident end vertices.
void	setUsesSubtypes(boolean bySubtype) Indicates if this edge feature source determines connectivity groups and policies by subtypes.

Method Detail

getClassConnectivityPolicy

int getClassConnectivityPolicy()
                               throws IOException,
                                      AutomationException

Policy determining how all edge elements in this source connect to each other.

Remarks

An EdgeFeatureSource can be assigned to a connectivity group in the network dataset in one of two ways:

• All features in the EdgeFeatureSource are assigned to the same connectivity group, or
• Features in the EdgeFeatureSource are assigned to a connectivity group based on their Subtype values.

If all features are assigned to the same connectivity group, then use the ClassConnectivityPolicy property to specify the appropriate edge connectivity policy for the features in this EdgeFeatureSource.

If features are assigned to a connectivity group based on their Subtype values, then the ClassConnectivityPolicy property is not used. See the SubtypeConnectivityPolicy property.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkEdgeConnectivityPolicy constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassConnectivityPolicy

void setClassConnectivityPolicy(int policy)
                                throws IOException,
                                       AutomationException

Policy determining how all edge elements in this source connect to each other.

Product Availability

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

Parameters:

policy - A com.esri.arcgis.geodatabase.esriNetworkEdgeConnectivityPolicy constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassConnectivityGroup

int getClassConnectivityGroup()
                              throws IOException,
                                     AutomationException

Connectivity group in which this edge feature source participates.

Remarks

An EdgeFeatureSource can be assigned to a connectivity group in the network dataset in one of two ways:

• All features in the EdgeFeatureSource are assigned to the same connectivity group, or
• Features in the EdgeFeatureSource are assigned to a connectivity group based on their Subtype values.

If all features are assigned to the same connectivity group, then use the ClassConnectivityGroup property to specify the connectivity group that this EdgeFeatureSource is assigned.

If features are assigned to a connectivity group based on their Subtype values, then the ClassConnectivityGroup property is not used. See the SubtypeConnectivityGroup property.

Product Availability

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

Returns:

The group

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassConnectivityGroup

void setClassConnectivityGroup(int group)
                               throws IOException,
                                      AutomationException

Connectivity group in which this edge feature source participates.

Product Availability

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

Parameters:

group - The group (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtypeConnectivityPolicy

int getSubtypeConnectivityPolicy(int subtypeCode)
                                 throws IOException,
                                        AutomationException

Policy determining how the edge elements in the specified subtype of this source connect to each other.

Product Availability

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

Parameters:

subtypeCode - The subtypeCode (in)

Returns:

A com.esri.arcgis.geodatabase.esriNetworkEdgeConnectivityPolicy constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtypeConnectivityPolicy

void setSubtypeConnectivityPolicy(int subtypeCode,
                                  int policy)
                                  throws IOException,
                                         AutomationException

Policy determining how the edge elements in the specified subtype of this source connect to each other.

Product Availability

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

Parameters:

subtypeCode - The subtypeCode (in)

policy - A com.esri.arcgis.geodatabase.esriNetworkEdgeConnectivityPolicy constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtypeConnectivityGroup

int getSubtypeConnectivityGroup(int subtypeCode)
                                throws IOException,
                                       AutomationException

Connectivity group in which the specified subtype of this edge feature source participates.

Product Availability

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

Parameters:

subtypeCode - The subtypeCode (in)

Returns:

The group

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtypeConnectivityGroup

void setSubtypeConnectivityGroup(int subtypeCode,
                                 int group)
                                 throws IOException,
                                        AutomationException

Connectivity group in which the specified subtype of this edge feature source participates.

Product Availability

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

Parameters:

subtypeCode - The subtypeCode (in)

group - The group (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsesSubtypes

boolean isUsesSubtypes()
                       throws IOException,
                              AutomationException

Indicates if this edge feature source determines connectivity groups and policies by subtypes.

Remarks

An EdgeFeatureSource can be assigned to a connectivity group in the network dataset in one of two ways:

• All features in the EdgeFeatureSource are assigned to the same connectivity group, or
• Features in the EdgeFeatureSource are assigned to a connectivity group based on their Subtype values.

If all features are assigned to the same connectivity group, then the UsesSubtypes property should be set to False. This means that the ClassConnectivityGroup and ClassConnectivityPolicysettings will apply to this EdgeFeatureSource.

If features are assigned to a connectivity group based on their Subtype values, then the UsesSubtypes property should be set to True. This means that the SubtypeConnectivityGroup and SubtypeConnectivityPolicysettings will apply to this EdgeFeatureSource.

Product Availability

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

Returns:

The bySubtype

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsesSubtypes

void setUsesSubtypes(boolean bySubtype)
                     throws IOException,
                            AutomationException

Indicates if this edge feature source determines connectivity groups and policies by subtypes.

Product Availability

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

Parameters:

bySubtype - The bySubtype (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromElevationFieldName

String getFromElevationFieldName()
                                 throws IOException,
                                        AutomationException

The field name on the feature source to be used as the from elevation field when determining connectivity at coincident end vertices.

Remarks

When using elevation field data, both the FromElevationFieldName and ToElevationFieldName must be specified.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromElevationFieldName

void setFromElevationFieldName(String name)
                               throws IOException,
                                      AutomationException

The field name on the feature source to be used as the from elevation field when determining connectivity at coincident end vertices.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToElevationFieldName

String getToElevationFieldName()
                               throws IOException,
                                      AutomationException

The field name on the feature source to be used as the to elevation field when determining connectivity at coincident end vertices.

Remarks

When using elevation field data, both the FromElevationFieldName and ToElevationFieldName must be specified.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToElevationFieldName

void setToElevationFieldName(String name)
                             throws IOException,
                                    AutomationException

The field name on the feature source to be used as the to elevation field when determining connectivity at coincident end vertices.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.