com.esri.arcgis.networkanalyst
Class NAStreetDirectionsAgent

java.lang.Object
  com.esri.arcgis.networkanalyst.NAStreetDirectionsAgent

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAAgent, INAStreetDirectionsAgent, INAStreetDirectionsAgent2, INAStreetDirectionsAgent3, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class NAStreetDirectionsAgent
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAAgent, INAStreetDirectionsAgent, INAStreetDirectionsAgent2, INAStreetDirectionsAgent3, IPersist, IPersistStream, IXMLSerialize, ISupportErrorInfo, java.io.Externalizable

COM Class 'NAStreetDirectionsAgent'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'Generates driving directions for network analysis results.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.networkanalyst.INAAgent

IID, IIDa6af9d1f_a27c_4df8_b989_8844173c776f, xxDummy

Fields inherited from interface com.esri.arcgis.networkanalyst.INAStreetDirectionsAgent3

IID, IID2497a983_b5e8_4f0c_a4e9_c70dc4ae62bc, xxDummy

Fields inherited from interface com.esri.arcgis.networkanalyst.INAStreetDirectionsAgent2

IID165a238e_761e_440c_b8d9_f028ecd40b97

Fields inherited from interface com.esri.arcgis.networkanalyst.INAStreetDirectionsAgent

IID67b62ed9_2ebb_488b_ae93_13c137ba4a84

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

NAStreetDirectionsAgent()
Constructs a NAStreetDirectionsAgent using ArcGIS Engine.

NAStreetDirectionsAgent(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAStreetDirectionsAgent theNAStreetDirectionsAgent = (NAStreetDirectionsAgent) obj;

Method Summary

boolean	applies(IDENetworkDataset network, INAContextHelper contextHelper) Indicates if the agent is appropriate to use with the given network dataset.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	execute(ISet set, ITrackCancel trackCancel) Constructs the directions.
IStringArray	getAvailableStyleNames() The collection of style names supported by the agent.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
INAStreetDirectionsContainer	getDirectionsContainer() The container for the directions.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLanguage() Language to use when generating directions.
int	getLengthUnits() The length units.
java.lang.String	getName() The name of the agent.
ISpatialReference	getOutputSpatialReference() Output spatial reference to use for geometries returned by the directions objects.
int	getOutputType() Output type to use when generating directions.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getStyleName() Style name to use when generating directions.
IStringArray	getSupportedLanguages() The collection of languages supported by the agent.
java.lang.String	getTimeAttributeName() The network attribute for time calculation.
int	hashCode() the hashcode for this object
void	initialize(IDENetworkDataset network, INAContextHelper contextHelper) Get the agent ready for action.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAutoShowDirections() Indicates if directions are automatically updated and shown when a route changes.
void	isDirty() isDirty
boolean	isDisplayTime() Indicates if time is displayed in directions.
void	load(IStream pstm) load
void	onContextUpdated() Called when the context is updated.
void	onResultUpdated() Called when a result is updated.
void	readExternal(java.io.ObjectInput in)
void	release() Release a NAStreetDirectionsAgent.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAutoShowDirections(boolean show) Indicates if directions are automatically updated and shown when a route changes.
void	setDisplayTime(boolean display) Indicates if time is displayed in directions.
void	setLanguage(java.lang.String strLanguage) Language to use when generating directions.
void	setLengthUnits(int units) The length units.
void	setOutputSpatialReferenceByRef(ISpatialReference ppSpatialReference) Output spatial reference to use for geometries returned by the directions objects.
void	setOutputType(int pOutputType) Output type to use when generating directions.
void	setStyleName(java.lang.String pStyleName) Style name to use when generating directions.
void	setTimeAttributeName(java.lang.String name) The network attribute for time calculation.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

NAStreetDirectionsAgent

public NAStreetDirectionsAgent()
                        throws java.io.IOException,
                               java.net.UnknownHostException

Constructs a NAStreetDirectionsAgent using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAStreetDirectionsAgent

public NAStreetDirectionsAgent(java.lang.Object obj)
                        throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAStreetDirectionsAgent theNAStreetDirectionsAgent = (NAStreetDirectionsAgent) obj;

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

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 NAStreetDirectionsAgent.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the agent.

Specified by:

getName in interface INAAgent

Returns:

The agentName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IDENetworkDataset network,
                       INAContextHelper contextHelper)
                throws java.io.IOException,
                       AutomationException

Indicates if the agent is appropriate to use with the given network dataset.

Specified by:

applies in interface INAAgent

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

contextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

Returns:

The agentApplies

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(IDENetworkDataset network,
                       INAContextHelper contextHelper)
                throws java.io.IOException,
                       AutomationException

Get the agent ready for action.

Specified by:

initialize in interface INAAgent

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

contextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onResultUpdated

public void onResultUpdated()
                     throws java.io.IOException,
                            AutomationException

Called when a result is updated.

Specified by:

onResultUpdated in interface INAAgent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onContextUpdated

public void onContextUpdated()
                      throws java.io.IOException,
                             AutomationException

Called when the context is updated.

Specified by:

onContextUpdated in interface INAAgent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLengthUnits

public int getLengthUnits()
                   throws java.io.IOException,
                          AutomationException

The length units.

Specified by:

getLengthUnits in interface INAStreetDirectionsAgent

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLengthUnits

public void setLengthUnits(int units)
                    throws java.io.IOException,
                           AutomationException

The length units.

Specified by:

setLengthUnits in interface INAStreetDirectionsAgent

Parameters:

units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayTime

public boolean isDisplayTime()
                      throws java.io.IOException,
                             AutomationException

Indicates if time is displayed in directions.

Specified by:

isDisplayTime in interface INAStreetDirectionsAgent

Returns:

The display

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTime

public void setDisplayTime(boolean display)
                    throws java.io.IOException,
                           AutomationException

Indicates if time is displayed in directions.

Specified by:

setDisplayTime in interface INAStreetDirectionsAgent

Parameters:

display - The display (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 network attribute for time calculation.

Specified by:

getTimeAttributeName in interface INAStreetDirectionsAgent

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

public void setTimeAttributeName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The network attribute for time calculation.

Specified by:

setTimeAttributeName in interface INAStreetDirectionsAgent

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoShowDirections

public boolean isAutoShowDirections()
                             throws java.io.IOException,
                                    AutomationException

Indicates if directions are automatically updated and shown when a route changes.

Specified by:

isAutoShowDirections in interface INAStreetDirectionsAgent

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoShowDirections

public void setAutoShowDirections(boolean show)
                           throws java.io.IOException,
                                  AutomationException

Indicates if directions are automatically updated and shown when a route changes.

Specified by:

setAutoShowDirections in interface INAStreetDirectionsAgent

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsContainer

public INAStreetDirectionsContainer getDirectionsContainer()
                                                    throws java.io.IOException,
                                                           AutomationException

The container for the directions.

Specified by:

getDirectionsContainer in interface INAStreetDirectionsAgent

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAStreetDirectionsContainer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISet set,
                    ITrackCancel trackCancel)
             throws java.io.IOException,
                    AutomationException

Constructs the directions.

Specified by:

execute in interface INAStreetDirectionsAgent

Parameters:

set - A reference to a com.esri.arcgis.system.ISet (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLanguage

public java.lang.String getLanguage()
                             throws java.io.IOException,
                                    AutomationException

Language to use when generating directions.

Specified by:

getLanguage in interface INAStreetDirectionsAgent2

Returns:

The strLanguage

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLanguage

public void setLanguage(java.lang.String strLanguage)
                 throws java.io.IOException,
                        AutomationException

Language to use when generating directions.

Specified by:

setLanguage in interface INAStreetDirectionsAgent2

Parameters:

strLanguage - The strLanguage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Output spatial reference to use for geometries returned by the directions objects.

Specified by:

getOutputSpatialReference in interface INAStreetDirectionsAgent3

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                                    throws java.io.IOException,
                                           AutomationException

Output spatial reference to use for geometries returned by the directions objects.

Specified by:

setOutputSpatialReferenceByRef in interface INAStreetDirectionsAgent3

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedLanguages

public IStringArray getSupportedLanguages()
                                   throws java.io.IOException,
                                          AutomationException

The collection of languages supported by the agent.

Specified by:

getSupportedLanguages in interface INAStreetDirectionsAgent3

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.

getAvailableStyleNames

public IStringArray getAvailableStyleNames()
                                    throws java.io.IOException,
                                           AutomationException

The collection of style names supported by the agent.

Specified by:

getAvailableStyleNames in interface INAStreetDirectionsAgent3

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.

getStyleName

public java.lang.String getStyleName()
                              throws java.io.IOException,
                                     AutomationException

Style name to use when generating directions.

Specified by:

getStyleName in interface INAStreetDirectionsAgent3

Returns:

The pStyleName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyleName

public void setStyleName(java.lang.String pStyleName)
                  throws java.io.IOException,
                         AutomationException

Style name to use when generating directions.

Specified by:

setStyleName in interface INAStreetDirectionsAgent3

Parameters:

pStyleName - The pStyleName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputType

public int getOutputType()
                  throws java.io.IOException,
                         AutomationException

Output type to use when generating directions.

Specified by:

getOutputType in interface INAStreetDirectionsAgent3

Returns:

A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputType

public void setOutputType(int pOutputType)
                   throws java.io.IOException,
                          AutomationException

Output type to use when generating directions.

Specified by:

setOutputType in interface INAStreetDirectionsAgent3

Parameters:

pOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException