com.esri.arcgis.geodatabase
Class NetWeight

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetWeight
All Implemented Interfaces:
INetWeight, INetWeightEdit, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class NetWeight
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetWeight, INetWeightEdit, IXMLSerialize, IClone, IPersistStream, Externalizable

A container for defining a weight on the network.

Remarks

Certain network features can have weights associated with them to further refine the network analysis performed by trace tasks. There are two main kinds of weights: ratio weights and categorical weights.

Ratio weights are associated with feature attributes that reflect the cost to traverse, either partially or in its entirety, a network feature. The values of a ratio weight are proportioned across the length of the network feature. Examples of ratio weights in a network include the length of a pipe in a water network and the time to travel a segment of road in a street network. Ratio weights are used by certain trace tasks that return a cost value. For example, the FindPath trace solver finds the path of minimal cost, based on the weight specified.

Categorical (or nominal) weights are associated with feature attributes that classify the feature. They are used to restrict tracing on specific features based on a certain attribute value. Examples of categorical weights in a network include the "Phase" attribute in circuits, the pipe diameter in a water network, and road classification in a street network.

Bitgate weights are a special kind of categorical weight. They allow multiple binary attributes to be specified in a single bitgate value. The bitgate size is the number of binary attributes represented by the bitgate value. The maximum bitgate size is 31.

For more information on weights, please see the ArcGIS Network Weight Model technical document.

The NetWeight object is used for establishing and viewing existing weights on a logical network. The NetWeight object is used to define the category of weight to use, while NetWeightAssociation objects are used to specify the fields with each feature class that will participate in the particular weight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
NetWeight()
          Constructs a NetWeight using ArcGIS Engine.
NetWeight(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetWeight theNetWeight = (NetWeight) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getBitGateSize()
          Bit gate size of the network weight described by this NetWeight object.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 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.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setBitGateSize(int rhs1)
          Bit gate size of this NetWeight object.
 void setWeightName(String rhs1)
          Name of this NetWeight object.
 void setWeightType(int rhs1)
          Type of network weight of this NetWeight object.
 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

NetWeight

public NetWeight()
          throws IOException,
                 UnknownHostException
Constructs a NetWeight using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NetWeight

public NetWeight(Object obj)
          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetWeight theNetWeight = (NetWeight) obj;

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

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

getWeightName

public 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

Specified by:
getWeightName in interface INetWeight
Returns:
The weightName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWeightType

public 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

Specified by:
getWeightType in interface INetWeight
Returns:
A com.esri.arcgis.geodatabase.esriWeightType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBitGateSize

public 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

Specified by:
getBitGateSize in interface INetWeight
Returns:
The bigGateSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWeightID

public 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

Specified by:
getWeightID in interface INetWeight
Returns:
The internalID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeightName

public void setWeightName(String rhs1)
                   throws IOException,
                          AutomationException
Name of this NetWeight object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWeightName in interface INetWeightEdit
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeightType

public void setWeightType(int rhs1)
                   throws IOException,
                          AutomationException
Type of network weight of this NetWeight object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWeightType in interface INetWeightEdit
Parameters:
rhs1 - A com.esri.arcgis.geodatabase.esriWeightType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBitGateSize

public void setBitGateSize(int rhs1)
                    throws IOException,
                           AutomationException
Bit gate size of this NetWeight object.

Remarks

BitGateSize can only be accessed if the WeightType property is esriWTBitGate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBitGateSize in interface INetWeightEdit
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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.

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