com.esri.arcgis.geodatabase
Class NetworkTravelMode

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkTravelMode
All Implemented Interfaces:
INetworkTravelMode, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class NetworkTravelMode
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkTravelMode

COM Class 'NetworkTravelMode'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for describing a travel mode in a network dataset.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geodatabase.INetworkTravelMode
IID, IIDcc5a89d8_01f3_4e50_8c4f_690b6511536c, xxDummy
 
Constructor Summary
NetworkTravelMode()
          Constructs a NetworkTravelMode using ArcGIS Engine.
NetworkTravelMode(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkTravelMode theNetworkTravelMode = (NetworkTravelMode) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 IArray getAttributeParameterValues()
          The collection of network attribute parameter values to be used with the analysis.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getDistanceAttributeName()
          The name of the distance-based network attribute to be used in analysis.
 java.lang.String getImpedanceAttributeName()
          The name of the network attribute to be used as the impedance attribute in analysis.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the travel mode.
 java.lang.Object getOutputGeometryPrecision()
          Specifies the precision of the output geometry after generalization.
 int getOutputGeometryPrecisionUnits()
          Specifies the units of the output geometry precision.
 IStringArray getRestrictionAttributeNames()
          The collection of network attribute names to be used as restrictions with the analysis.
 int getRestrictUTurns()
          Indicates how U-Turns should be restricted in the analysis.
 java.lang.String getTimeAttributeName()
          The name of the time-based network attribute to be used in analysis.
 int hashCode()
          the hashcode for this object
 boolean isUseHierarchy()
          Indicates if the hierarchy attribute for the network should be used in analysis.
 void readFromJSON(java.lang.String jsonValue)
          Reads the contents of this travel mode from a JSON string.
 void release()
          Release a NetworkTravelMode.
 void setAttributeParameterValuesByRef(IArray attributeParameterValues)
          The collection of network attribute parameter values to be used with the analysis.
 void setDistanceAttributeName(java.lang.String attributeName)
          The name of the distance-based network attribute to be used in analysis.
 void setImpedanceAttributeName(java.lang.String attributeName)
          The name of the network attribute to be used as the impedance attribute in analysis.
 void setName(java.lang.String name)
          The name of the travel mode.
 void setOutputGeometryPrecision(java.lang.Object precision)
          Specifies the precision of the output geometry after generalization.
 void setOutputGeometryPrecisionUnits(int units)
          Specifies the units of the output geometry precision.
 void setRestrictionAttributeNamesByRef(IStringArray attributeNames)
          The collection of network attribute names to be used as restrictions with the analysis.
 void setRestrictUTurns(int backtrack)
          Indicates how U-Turns should be restricted in the analysis.
 void setTimeAttributeName(java.lang.String attributeName)
          The name of the time-based network attribute to be used in analysis.
 void setUseHierarchy(boolean useHierarchy)
          Indicates if the hierarchy attribute for the network should be used in analysis.
 void writeToJSON(java.lang.String[] jsonValue)
          Writes the contents of this travel mode as a JSON string.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetworkTravelMode

public NetworkTravelMode()
                  throws java.io.IOException,
                         java.net.UnknownHostException
Constructs a NetworkTravelMode using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

NetworkTravelMode

public NetworkTravelMode(java.lang.Object obj)
                  throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkTravelMode theNetworkTravelMode = (NetworkTravelMode) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a NetworkTravelMode.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The name of the travel mode.

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the travel mode.

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

setImpedanceAttributeName

public void setImpedanceAttributeName(java.lang.String attributeName)
                               throws java.io.IOException,
                                      AutomationException
The name of the network attribute to be used as the impedance attribute in analysis.

Specified by:
setImpedanceAttributeName in interface INetworkTravelMode
Parameters:
attributeName - The attributeName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImpedanceAttributeName

public java.lang.String getImpedanceAttributeName()
                                           throws java.io.IOException,
                                                  AutomationException
The name of the network attribute to be used as the impedance attribute in analysis.

Specified by:
getImpedanceAttributeName in interface INetworkTravelMode
Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

public void setTimeAttributeName(java.lang.String attributeName)
                          throws java.io.IOException,
                                 AutomationException
The name of the time-based network attribute to be used in analysis.

Specified by:
setTimeAttributeName in interface INetworkTravelMode
Parameters:
attributeName - The attributeName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeAttributeName

public java.lang.String getTimeAttributeName()
                                      throws java.io.IOException,
                                             AutomationException
The name of the time-based network attribute to be used in analysis.

Specified by:
getTimeAttributeName in interface INetworkTravelMode
Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceAttributeName

public void setDistanceAttributeName(java.lang.String attributeName)
                              throws java.io.IOException,
                                     AutomationException
The name of the distance-based network attribute to be used in analysis.

Specified by:
setDistanceAttributeName in interface INetworkTravelMode
Parameters:
attributeName - The attributeName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceAttributeName

public java.lang.String getDistanceAttributeName()
                                          throws java.io.IOException,
                                                 AutomationException
The name of the distance-based network attribute to be used in analysis.

Specified by:
getDistanceAttributeName in interface INetworkTravelMode
Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeNames)
                                       throws java.io.IOException,
                                              AutomationException
The collection of network attribute names to be used as restrictions with the analysis.

Specified by:
setRestrictionAttributeNamesByRef in interface INetworkTravelMode
Parameters:
attributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws java.io.IOException,
                                                 AutomationException
The collection of network attribute names to be used as restrictions with the analysis.

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

setAttributeParameterValuesByRef

public void setAttributeParameterValuesByRef(IArray attributeParameterValues)
                                      throws java.io.IOException,
                                             AutomationException
The collection of network attribute parameter values to be used with the analysis.

Specified by:
setAttributeParameterValuesByRef in interface INetworkTravelMode
Parameters:
attributeParameterValues - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeParameterValues

public IArray getAttributeParameterValues()
                                   throws java.io.IOException,
                                          AutomationException
The collection of network attribute parameter values to be used with the analysis.

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

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws java.io.IOException,
                            AutomationException
Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:
setUseHierarchy in interface INetworkTravelMode
Parameters:
useHierarchy - The useHierarchy (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseHierarchy

public boolean isUseHierarchy()
                       throws java.io.IOException,
                              AutomationException
Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:
isUseHierarchy in interface INetworkTravelMode
Returns:
The useHierarchy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws java.io.IOException,
                              AutomationException
Indicates how U-Turns should be restricted in the analysis.

Specified by:
setRestrictUTurns in interface INetworkTravelMode
Parameters:
backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRestrictUTurns

public int getRestrictUTurns()
                      throws java.io.IOException,
                             AutomationException
Indicates how U-Turns should be restricted in the analysis.

Specified by:
getRestrictUTurns in interface INetworkTravelMode
Returns:
A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputGeometryPrecision

public void setOutputGeometryPrecision(java.lang.Object precision)
                                throws java.io.IOException,
                                       AutomationException
Specifies the precision of the output geometry after generalization.

Specified by:
setOutputGeometryPrecision in interface INetworkTravelMode
Parameters:
precision - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputGeometryPrecision

public java.lang.Object getOutputGeometryPrecision()
                                            throws java.io.IOException,
                                                   AutomationException
Specifies the precision of the output geometry after generalization.

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

setOutputGeometryPrecisionUnits

public void setOutputGeometryPrecisionUnits(int units)
                                     throws java.io.IOException,
                                            AutomationException
Specifies the units of the output geometry precision.

Specified by:
setOutputGeometryPrecisionUnits in interface INetworkTravelMode
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputGeometryPrecisionUnits

public int getOutputGeometryPrecisionUnits()
                                    throws java.io.IOException,
                                           AutomationException
Specifies the units of the output geometry precision.

Specified by:
getOutputGeometryPrecisionUnits in interface INetworkTravelMode
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeToJSON

public void writeToJSON(java.lang.String[] jsonValue)
                 throws java.io.IOException,
                        AutomationException
Writes the contents of this travel mode as a JSON string.

Specified by:
writeToJSON in interface INetworkTravelMode
Parameters:
jsonValue - The jsonValue (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readFromJSON

public void readFromJSON(java.lang.String jsonValue)
                  throws java.io.IOException,
                         AutomationException
Reads the contents of this travel mode from a JSON string.

Specified by:
readFromJSON in interface INetworkTravelMode
Parameters:
jsonValue - The jsonValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.