com.esri.arcgis.geodatabase
Interface INetworkAttribute

All Superinterfaces:

Serializable

All Known Subinterfaces:

IEvaluatedNetworkAttribute, IEvaluatedNetworkAttribute2, INetworkAttribute2

All Known Implementing Classes:

EvaluatedNetworkAttribute, INetworkAttribute2Proxy, INetworkAttributeProxy, NetworkAttribute, SDCNetworkAttribute

public interface INetworkAttribute
extends Serializable

Provides access to members that specify the properties of an attribute in a network dataset.

Superseded By

INetworkAttribute2

Remarks

The INetworkAttribute and INetworkAttribute2 interfaces are used to access the properties of the network attribute, such as its name and usage type.

To access the NetworkAttribute or EvaluatedNetworkAttribute object for an existing network dataset attribute, use the Attribute, AttributeByID, or AttributeByName methods on the INetworkDataset interface.

The INetworkAttribute and INetworkAttribute2 interfaces are also used to define a new network attribute. To create a new network attribute, cocreate an EvaluatedNetworkAttribute object, specify its properties, and pass the object to the INetworkBuild::AddAttribute method on the network dataset.

Product Availability

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

Method Summary

int	getDataType() Type of data used in this network attribute.
int	getID() Unique identifier of this network attribute.
String	getName() Name of this network attribute.
int	getUnits() Units of this network attribute.
int	getUsageType() Usage type of this network attribute.
void	setDataType(int dataType) Type of data used in this network attribute.
void	setName(String attributeName) Name of this network attribute.
void	setUnits(int units) Units of this network attribute.
void	setUsageType(int usageType) Usage type of this network attribute.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of this network attribute.

Product Availability

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

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String attributeName)
             throws IOException,
                    AutomationException

Name of this network attribute.

Product Availability

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

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

int getID()
          throws IOException,
                 AutomationException

Unique identifier of this network attribute.

Product Availability

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

Returns:

The attributeID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

int getDataType()
                throws IOException,
                       AutomationException

Type of data used in this network attribute.

Remarks

The DataType for the network attribute can be either Integer, Float, Double, or Boolean.

Depending on the UsageType for the network attribute, only certain DataTypes are allowed:

UsageType:	Allowed DataTypes:
esriNAUTCost	esriNADTInteger, esriNADTFloat, esriNADTDouble
esriNAUTDescriptor	esriNADTInteger, esriNADTFloat, esriNADTDouble, esriNADTBoolean
esriNAUTRestriction	esriNADTBoolean
esriNAUTHierarchy	esriNADTInteger

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

void setDataType(int dataType)
                 throws IOException,
                        AutomationException

Type of data used in this network attribute.

Product Availability

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

Parameters:

dataType - A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUsageType

int getUsageType()
                 throws IOException,
                        AutomationException

Usage type of this network attribute.

Remarks

The UsageType for the network attribute can be either Cost, Descriptor, Restriction, or Hierarchy.

Depending on the UsageType for the network attribute, only certain DataTypes are allowed:

UsageType:	Allowed DataTypes:
esriNAUTCost	esriNADTInteger, esriNADTFloat, esriNADTDouble
esriNAUTDescriptor	esriNADTInteger, esriNADTFloat, esriNADTDouble, esriNADTBoolean
esriNAUTRestriction	esriNADTBoolean
esriNAUTHierarchy	esriNADTInteger

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUsageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUsageType

void setUsageType(int usageType)
                  throws IOException,
                         AutomationException

Usage type of this network attribute.

Product Availability

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

Parameters:

usageType - A com.esri.arcgis.geodatabase.esriNetworkAttributeUsageType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException

Units of this network attribute.

Remarks

If the attribute is not measured in units of distance or time, specify the Units as esriNAUUnknown.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int units)
              throws IOException,
                     AutomationException

Units of this network attribute.

Product Availability

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

Parameters:

units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.