com.esri.arcgis.geodatabase
Class INetworkAttribute2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.INetworkAttributeProxy
          com.esri.arcgis.geodatabase.INetworkAttribute2Proxy

All Implemented Interfaces:

INetworkAttribute, INetworkAttribute2, Externalizable, Serializable

public class INetworkAttribute2Proxy
extends INetworkAttributeProxy
implements INetworkAttribute2, Serializable

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

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	INetworkAttribute2Proxy()
	INetworkAttribute2Proxy(Object obj)
protected	INetworkAttribute2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IArray	getParameters() Array of parameters for this network attribute.
boolean	isUseByDefault() Indicates if this network attribute is to be used by default.
void	readExternal(ObjectInput in)
void	refresh() Refresh the network evaluators assigned to this network attribute.
void	removeListener(String iidStr, Object theListener)
void	setParametersByRef(IArray parameters) Array of parameters for this network attribute.
void	setUseByDefault(boolean useByDefault) Indicates if this network attribute is to be used by default.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.geodatabase.INetworkAttributeProxy

getDataType, getID, getName, getUnits, getUsageType, setDataType, setName, setUnits, setUsageType

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.geodatabase.INetworkAttribute

getDataType, getID, getName, getUnits, getUsageType, setDataType, setName, setUnits, setUsageType

Constructor Detail

INetworkAttribute2Proxy

public INetworkAttribute2Proxy()

INetworkAttribute2Proxy

public INetworkAttribute2Proxy(Object obj)
                        throws IOException

Throws:

IOException

INetworkAttribute2Proxy

protected INetworkAttribute2Proxy(Object obj,
                                  String iid)
                           throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class INetworkAttributeProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class INetworkAttributeProxy

Throws:

IOException

getParameters

public IArray getParameters()
                     throws IOException,
                            AutomationException

Array of parameters for this network attribute.

Remarks

This property provides access to the IArray interface that holds the collection of NetworkAttributeParameter objects that are available for this NetworkAttribute.

Product Availability

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

Specified by:

getParameters in interface INetworkAttribute2

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParametersByRef

public void setParametersByRef(IArray parameters)
                        throws IOException,
                               AutomationException

Array of parameters for this network attribute.

Remarks

This property provides access to the IArray interface that holds the collection of NetworkAttributeParameter objects that are available for this NetworkAttribute.

Product Availability

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

Specified by:

setParametersByRef in interface INetworkAttribute2

Parameters:

parameters - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refresh the network evaluators assigned to this network attribute.

Remarks

Calling Refresh propogates the call to INetworkEvaluator2::Refresh on the attribute's underlying network evaluators that implement INetworkEvaluator2. This gives the evaluator an opportunity to update its state based on current data or parameter values. This method is called by the network analyst solvers after setting INetworkAttribute2::Parameters prior to performing the solve operation.

Product Availability

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

Specified by:

refresh in interface INetworkAttribute2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseByDefault

public boolean isUseByDefault()
                       throws IOException,
                              AutomationException

Indicates if this network attribute is to be used by default.

Remarks

If the UseByDefault property is set to True for a NetworkAttribute, the network attribute will automatically be set as an option (e.g., impedance, restriction, hierarchy) when a new network analysis layer is created in ArcMap.

Product Availability

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

Specified by:

isUseByDefault in interface INetworkAttribute2

Returns:

The useByDefault

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseByDefault

public void setUseByDefault(boolean useByDefault)
                     throws IOException,
                            AutomationException

Indicates if this network attribute is to be used by default.

Product Availability

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

Specified by:

setUseByDefault in interface INetworkAttribute2

Parameters:

useByDefault - The useByDefault (in)

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

Overrides:

writeExternal in class INetworkAttributeProxy

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class INetworkAttributeProxy

Throws:

IOException

ClassNotFoundException