Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Interface INetworkTravelMode

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
INetworkTravelModeProxy, NetworkTravelMode
public interface INetworkTravelMode
extends java.io.Serializable

COM Interface 'INetworkTravelMode'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that specify the properties of 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDcc5a89d8_01f3_4e50_8c4f_690b6511536c
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IArray getAttributeParameterValues()
          The collection of network attribute parameter values to be used with the analysis.
 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.
 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.
 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 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.
 

Field Detail

IIDcc5a89d8_01f3_4e50_8c4f_690b6511536c

static final int IIDcc5a89d8_01f3_4e50_8c4f_690b6511536c
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setName

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

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

getName

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

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setImpedanceAttributeName

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.

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

getImpedanceAttributeName

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

Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

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

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

getTimeAttributeName

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

Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceAttributeName

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

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

getDistanceAttributeName

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

Returns:
The attributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

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

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

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

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

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

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

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

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

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

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

isUseHierarchy

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

Returns:
The useHierarchy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

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

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

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

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

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

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

getOutputGeometryPrecision

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

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputGeometryPrecisionUnits

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

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

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

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

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

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

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

Parameters:
jsonValue - The jsonValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD