com.esri.arcgis.geodatabase
Class NetworkAttributeParameter

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkAttributeParameter
All Implemented Interfaces:
INetworkAttributeParameter, INetworkAttributeParameter2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetworkAttributeParameter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkAttributeParameter, INetworkAttributeParameter2

A container for describing a network attribute parameter.

Remarks

The NetworkAttributeParameter object is used to specify the Name, DefaultValue, and Value of a parameter used by the network attribute. It is accessed using the INetworkAttributeParameter interface.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NetworkAttributeParameter()
          Constructs a NetworkAttributeParameter using ArcGIS Engine.
NetworkAttributeParameter(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkAttributeParameter theNetworkAttributeParameter = (NetworkAttributeParameter) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 Object getDefaultValue()
          The default value of the parameter.
 String getName()
          The name of the parameter.
 int getParameterUsageType()
          The usage type of the parameter.
 Object getValue()
          The current value of the parameter.
 int getVarType()
          The VARTYPE of the parameter (e.g.
 int hashCode()
          the hashcode for this object
 void setDefaultValue(Object value)
          The default value of the parameter.
 void setName(String name)
          The name of the parameter.
 void setParameterUsageType(int parameterUsageType)
          The usage type of the parameter.
 void setValue(Object value)
          The current value of the parameter.
 void setVarType(int value)
          The VARTYPE of the parameter (e.g.
 
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

NetworkAttributeParameter

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

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

NetworkAttributeParameter

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the parameter.

Remarks

The Name is the name of the parameter. This name must be unique among all of the parameters of a network attribute.

Product Availability

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

Specified by:
getName in interface INetworkAttributeParameter
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The name of the parameter.

Remarks

The Name is the name of the parameter. This name must be unique among all of the parameters of a network attribute.

Product Availability

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

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

getDefaultValue

public Object getDefaultValue()
                       throws IOException,
                              AutomationException
The default value of the parameter.

Remarks

The DefaultValue property is the parameter value stored in the NetworkDataset that should be be used to initialize the Value property. The variant type of the parameter is based off the DefaultValue's variant type.

Product Availability

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

Specified by:
getDefaultValue in interface INetworkAttributeParameter
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(Object value)
                     throws IOException,
                            AutomationException
The default value of the parameter.

Remarks

The DefaultValue property is the parameter value stored in the NetworkDataset that should be be used to initialize the Value property. The variant type of the parameter is based off the DefaultValue's variant type.

Product Availability

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

Specified by:
setDefaultValue in interface INetworkAttributeParameter
Parameters:
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue()
                throws IOException,
                       AutomationException
The current value of the parameter.

Remarks

The Value property is the parameter value that should be used by the attribute and evaluators during analysis time. This is the run-time value for the parameter.

Product Availability

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

Specified by:
getValue in interface INetworkAttributeParameter
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(Object value)
              throws IOException,
                     AutomationException
The current value of the parameter.

Remarks

The Value property is the parameter value that should be used by the attribute and evaluators during analysis time. This is the run-time value for the parameter.

Product Availability

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

Specified by:
setValue in interface INetworkAttributeParameter
Parameters:
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVarType

public int getVarType()
               throws IOException,
                      AutomationException
The VARTYPE of the parameter (e.g. VT_I4).

Product Availability

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

Specified by:
getVarType in interface INetworkAttributeParameter
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVarType

public void setVarType(int value)
                throws IOException,
                       AutomationException
The VARTYPE of the parameter (e.g. VT_I4).

Product Availability

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

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

getParameterUsageType

public int getParameterUsageType()
                          throws IOException,
                                 AutomationException
The usage type of the parameter.

Product Availability

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

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

setParameterUsageType

public void setParameterUsageType(int parameterUsageType)
                           throws IOException,
                                  AutomationException
The usage type of the parameter.

Product Availability

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

Specified by:
setParameterUsageType in interface INetworkAttributeParameter2
Parameters:
parameterUsageType - A com.esri.arcgis.geodatabase.esriNetworkAttributeParameterUsageType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.