com.esri.arcgis.geodatabase
Interface INetWeight

All Superinterfaces:

Serializable

All Known Subinterfaces:

INetWeightEdit

All Known Implementing Classes:

NetWeight

public interface INetWeight
extends Serializable

Provides access to members that get information about the network weight described by this NetWeight object.

Remarks

A weight is the 'cost' of moving along a feature in a network. In a street network this could be the speed limit along a road. In a water utility network this could be the diameter of a pipe which can have an effect on the amount of flow through the pipe. To get all of the weights on a network use the INetSchema interface.

When To Use

Use the INetWeight interface to retrieve information about a particular weight including its name, type, and (for a weight of type esriWTBitgate) its bitgate size.

Product Availability

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

See Also:

INetWeightEdit, INetWeightAssociation, INetWeightAssociationEdit, INetWeight

Method Summary

int	getBitGateSize() Bit gate size of the network weight described by this NetWeight object.
int	getWeightID() Internal ID of the network weight described by this NetWeight object.
String	getWeightName() Name of the network weight described by this NetWeight object.
int	getWeightType() Type of network weight described by this NetWeight object.

Method Detail

getWeightName

String getWeightName()
                     throws IOException,
                            AutomationException

Name of the network weight described by this NetWeight object.

Remarks

The WeightName property returns the name of the network that was supplied at it's time of creation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The weightName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWeightType

int getWeightType()
                  throws IOException,
                         AutomationException

Type of network weight described by this NetWeight object.

Remarks

WeightType returns the type of network weight, corresponding to a value from the esriWeightType enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriWeightType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitGateSize

int getBitGateSize()
                   throws IOException,
                          AutomationException

Bit gate size of the network weight described by this NetWeight object.

Remarks

BitGateSize can only be accessed if the WeightType property is esriWTBitGate and contains the number bits to used as the bit gate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bigGateSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWeightID

int getWeightID()
                throws IOException,
                       AutomationException

Internal ID of the network weight described by this NetWeight object.

Remarks

The WeightID property returns the unique ID of the network weight within the network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The internalID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.