com.esri.arcgis.geodatabase

Class TNTracerService

java.lang.Object

com.esri.arcgis.geodatabase.TNTracerService

All Implemented Interfaces:

ITracer, ITraceResults, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class TNTracerService
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITracer, ITraceResults

COM Class 'TNTracerService'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Trace Network Tracer.' 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.ITracer

IID, IID8a5938f3_74a8_43b9_961c_59083d327137, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITraceResults

IID, IID29c70874_c8c3_4964_b681_c14a167641ee, xxDummy

Constructor Summary

Constructors

Constructor and Description
TNTracerService(java.lang.Object obj) Construct a TNTracerService using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
void	addTraceLocation(int type, int elementType, long eID) Adds a trace location.
void	addTraceLocationForEdgeFeatures(int type, IStringArray edgeGlobalIDs, IDoubleArray percentAlongLengths) Adds trace location for edge features.
void	addTraceLocationForJunctionFeatures(int type, IStringArray junctionGlobalIDs, ILongArray terminalIDs) Adds trace location for junction features.
void	addTraceLocations(int type, int[] elementTypes, long[] eIDs) Adds trace locations.
void	addTraceLocationsFromGeometries(int type, IArray geometries) Add the given geometries as trace locations.
void	deleteTraceLocations(int type) Deletes all trace locations.
boolean	equals(java.lang.Object o) Compare this object with another
void	getAggregatedGeometries(IGeometry[] aggregatedPointGeometry, IGeometry[] aggregatedLineGeometry, IGeometry[] aggregatedPolygonGeometry) Returns aggregated geometries.
java.lang.Object	getGlobalFunctionResult(IUNFunction function) Returns the global function result.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IArray	getResultTypes() Returns the result types.
ITraceConfiguration	getTraceConfiguration() Returns trace configuration.
GUID	getTraceConfigurationGlobalID() Returns trace configuration global ID.
void	getTraceLocations(int type, int[][] elementTypes, long[][] eIDs) Returns trace locations.
void	getTraceResultConnectivity(ILongArray[] viaNetworkSourceIDs, IStringArray[] viaGlobalIDs, ILongArray[] viaObjectIDs, IDoubleArray[] viaPositionFroms, IDoubleArray[] viaPositionTos, IArray[] viaGeometries, ILongArray[] fromNetworkSourceIDs, IStringArray[] fromGlobalIDs, ILongArray[] fromObjectIDs, ILongArray[] fromTerminalIDs, IArray[] fromGeometries, ILongArray[] toNetworkSourceIDs, IStringArray[] toGlobalIDs, ILongArray[] toObjectIDs, ILongArray[] toTerminalIDs, IArray[] toGeometries) Returns connectivity information for trace results.
void	getTraceResultFeatures(ILongArray[] junctionNetworkSourceIDs, IStringArray[] junctionGlobalIDs, ILongArray[] junctionObjectIDs, ILongArray[] junctionTerminalIDs, ILongArray[] junctionAssetGroupCodes, ILongArray[] junctionAssetTypeCodes, ILongArray[] edgeNetworkSourceIDs, IStringArray[] edgeGlobalIDs, ILongArray[] edgeObjectIDs, ILongArray[] edgeAssetGroupCodes, ILongArray[] edgeAssetTypeCodes) Returns the trace results as features.
void	getTraceResultFeaturesWithPosition(ILongArray[] junctionNetworkSourceIDs, IStringArray[] junctionGlobalIDs, ILongArray[] junctionObjectIDs, ILongArray[] junctionTerminalIDs, ILongArray[] junctionAssetGroupCodes, ILongArray[] junctionAssetTypeCodes, ILongArray[] edgeNetworkSourceIDs, IStringArray[] edgeGlobalIDs, ILongArray[] edgeObjectIDs, ILongArray[] edgeAssetGroupCodes, ILongArray[] edgeAssetTypeCodes, IDoubleArray[] edgePositionFroms, IDoubleArray[] edgePositionTos) Returns the trace results as features with position from and position to for lines.
IStringArray	getWarnings() Returns warnings.
int	hashCode() the hashcode for this object
void	initialize(IUtilityNetworkQuery unQuery, IDataElement definition) Initializes the tracer.
void	release() Release this COM object reference
void	setResultTypesByRef(IArray resultTypes) Returns the result types.
void	setTraceConfigurationByRef(ITraceConfiguration traceConfiguration) Returns trace configuration.
void	setTraceConfigurationGlobalID(GUID globalID) Returns trace configuration global ID.
void	trace(int traceType, long[][] junctionEIDs, long[][] edgeEIDs) Execute the given trace.
void	traceEx(int traceType, boolean asynchronous, long[][] junctionEIDs, long[][] edgeEIDs) Execute the given trace.

Methods inherited from class java.lang.Object

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

Constructor Detail

TNTracerService

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

Construct a TNTracerService using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TNTracerService.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
TNTracerService o = (TNTracerService)obj; // will not work

TNTracerService o = new TNTracerService(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TNTracerService theTNTracerService = (TNTracerService) obj;

Method Detail

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

initialize

public void initialize(IUtilityNetworkQuery unQuery,
                       IDataElement definition)
                throws java.io.IOException,
                       AutomationException

Initializes the tracer.

Specified by:

initialize in interface ITracer

Parameters:

unQuery - A reference to a com.esri.arcgis.geodatabase.IUtilityNetworkQuery (in)

definition - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTraceLocation

public void addTraceLocation(int type,
                             int elementType,
                             long eID)
                      throws java.io.IOException,
                             AutomationException

Adds a trace location.

Specified by:

addTraceLocation in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTraceLocations

public void addTraceLocations(int type,
                              int[] elementTypes,
                              long[] eIDs)
                       throws java.io.IOException,
                              AutomationException

Adds trace locations.

Specified by:

addTraceLocations in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

elementTypes - A com.esri.arcgis.geodatabase.esriElementType constant array (in)

eIDs - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteTraceLocations

public void deleteTraceLocations(int type)
                          throws java.io.IOException,
                                 AutomationException

Deletes all trace locations.

Specified by:

deleteTraceLocations in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTraceLocations

public void getTraceLocations(int type,
                              int[][] elementTypes,
                              long[][] eIDs)
                       throws java.io.IOException,
                              AutomationException

Returns trace locations.

Specified by:

getTraceLocations in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

elementTypes - A com.esri.arcgis.geodatabase.esriElementType constant array (out: use single element array)

eIDs - Signed 64-bit int (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTraceLocationForJunctionFeatures

public void addTraceLocationForJunctionFeatures(int type,
                                                IStringArray junctionGlobalIDs,
                                                ILongArray terminalIDs)
                                         throws java.io.IOException,
                                                AutomationException

Adds trace location for junction features.

Specified by:

addTraceLocationForJunctionFeatures in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

junctionGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (in)

terminalIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTraceLocationForEdgeFeatures

public void addTraceLocationForEdgeFeatures(int type,
                                            IStringArray edgeGlobalIDs,
                                            IDoubleArray percentAlongLengths)
                                     throws java.io.IOException,
                                            AutomationException

Adds trace location for edge features.

Specified by:

addTraceLocationForEdgeFeatures in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

edgeGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (in)

percentAlongLengths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTraceLocationsFromGeometries

public void addTraceLocationsFromGeometries(int type,
                                            IArray geometries)
                                     throws java.io.IOException,
                                            AutomationException

Add the given geometries as trace locations.

Specified by:

addTraceLocationsFromGeometries in interface ITracer

Parameters:

type - A com.esri.arcgis.geodatabase.esriTraceLocationType constant (in)

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

getTraceConfiguration

public ITraceConfiguration getTraceConfiguration()
                                          throws java.io.IOException,
                                                 AutomationException

Returns trace configuration.

Specified by:

getTraceConfiguration in interface ITracer

Returns:

A reference to a com.esri.arcgis.geodatabase.ITraceConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTraceConfigurationByRef

public void setTraceConfigurationByRef(ITraceConfiguration traceConfiguration)
                                throws java.io.IOException,
                                       AutomationException

Returns trace configuration.

Specified by:

setTraceConfigurationByRef in interface ITracer

Parameters:

traceConfiguration - A reference to a com.esri.arcgis.geodatabase.ITraceConfiguration (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultTypes

public IArray getResultTypes()
                      throws java.io.IOException,
                             AutomationException

Returns the result types.

Specified by:

getResultTypes in interface ITracer

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.

setResultTypesByRef

public void setResultTypesByRef(IArray resultTypes)
                         throws java.io.IOException,
                                AutomationException

Returns the result types.

Specified by:

setResultTypesByRef in interface ITracer

Parameters:

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

trace

public void trace(int traceType,
                  long[][] junctionEIDs,
                  long[][] edgeEIDs)
           throws java.io.IOException,
                  AutomationException

Execute the given trace.

Specified by:

trace in interface ITracer

Parameters:

traceType - A com.esri.arcgis.geodatabase.esriUtilityNetworkTraceType constant (in)

junctionEIDs - Signed 64-bit int (out: use single element array)

edgeEIDs - Signed 64-bit int (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTraceConfigurationGlobalID

public GUID getTraceConfigurationGlobalID()
                                   throws java.io.IOException,
                                          AutomationException

Returns trace configuration global ID.

Specified by:

getTraceConfigurationGlobalID in interface ITracer

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTraceConfigurationGlobalID

public void setTraceConfigurationGlobalID(GUID globalID)
                                   throws java.io.IOException,
                                          AutomationException

Returns trace configuration global ID.

Specified by:

setTraceConfigurationGlobalID in interface ITracer

Parameters:

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

traceEx

public void traceEx(int traceType,
                    boolean asynchronous,
                    long[][] junctionEIDs,
                    long[][] edgeEIDs)
             throws java.io.IOException,
                    AutomationException

Execute the given trace.

Specified by:

traceEx in interface ITracer

Parameters:

traceType - A com.esri.arcgis.geodatabase.esriUtilityNetworkTraceType constant (in)

asynchronous - The asynchronous (in)

junctionEIDs - Signed 64-bit int (out: use single element array)

edgeEIDs - Signed 64-bit int (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobalFunctionResult

public java.lang.Object getGlobalFunctionResult(IUNFunction function)
                                         throws java.io.IOException,
                                                AutomationException

Returns the global function result.

Specified by:

getGlobalFunctionResult in interface ITraceResults

Parameters:

function - A reference to a com.esri.arcgis.geodatabase.IUNFunction (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTraceResultFeatures

public void getTraceResultFeatures(ILongArray[] junctionNetworkSourceIDs,
                                   IStringArray[] junctionGlobalIDs,
                                   ILongArray[] junctionObjectIDs,
                                   ILongArray[] junctionTerminalIDs,
                                   ILongArray[] junctionAssetGroupCodes,
                                   ILongArray[] junctionAssetTypeCodes,
                                   ILongArray[] edgeNetworkSourceIDs,
                                   IStringArray[] edgeGlobalIDs,
                                   ILongArray[] edgeObjectIDs,
                                   ILongArray[] edgeAssetGroupCodes,
                                   ILongArray[] edgeAssetTypeCodes)
                            throws java.io.IOException,
                                   AutomationException

Returns the trace results as features.

Specified by:

getTraceResultFeatures in interface ITraceResults

Parameters:

junctionNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

junctionObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionTerminalIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionAssetGroupCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionAssetTypeCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

edgeObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeAssetGroupCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeAssetTypeCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWarnings

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

Returns warnings.

Specified by:

getWarnings in interface ITraceResults

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.

getAggregatedGeometries

public void getAggregatedGeometries(IGeometry[] aggregatedPointGeometry,
                                    IGeometry[] aggregatedLineGeometry,
                                    IGeometry[] aggregatedPolygonGeometry)
                             throws java.io.IOException,
                                    AutomationException

Returns aggregated geometries.

Specified by:

getAggregatedGeometries in interface ITraceResults

Parameters:

aggregatedPointGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

aggregatedLineGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

aggregatedPolygonGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTraceResultFeaturesWithPosition

public void getTraceResultFeaturesWithPosition(ILongArray[] junctionNetworkSourceIDs,
                                               IStringArray[] junctionGlobalIDs,
                                               ILongArray[] junctionObjectIDs,
                                               ILongArray[] junctionTerminalIDs,
                                               ILongArray[] junctionAssetGroupCodes,
                                               ILongArray[] junctionAssetTypeCodes,
                                               ILongArray[] edgeNetworkSourceIDs,
                                               IStringArray[] edgeGlobalIDs,
                                               ILongArray[] edgeObjectIDs,
                                               ILongArray[] edgeAssetGroupCodes,
                                               ILongArray[] edgeAssetTypeCodes,
                                               IDoubleArray[] edgePositionFroms,
                                               IDoubleArray[] edgePositionTos)
                                        throws java.io.IOException,
                                               AutomationException

Returns the trace results as features with position from and position to for lines.

Specified by:

getTraceResultFeaturesWithPosition in interface ITraceResults

Parameters:

junctionNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

junctionObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionTerminalIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionAssetGroupCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

junctionAssetTypeCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

edgeObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeAssetGroupCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgeAssetTypeCodes - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

edgePositionFroms - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

edgePositionTos - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTraceResultConnectivity

public void getTraceResultConnectivity(ILongArray[] viaNetworkSourceIDs,
                                       IStringArray[] viaGlobalIDs,
                                       ILongArray[] viaObjectIDs,
                                       IDoubleArray[] viaPositionFroms,
                                       IDoubleArray[] viaPositionTos,
                                       IArray[] viaGeometries,
                                       ILongArray[] fromNetworkSourceIDs,
                                       IStringArray[] fromGlobalIDs,
                                       ILongArray[] fromObjectIDs,
                                       ILongArray[] fromTerminalIDs,
                                       IArray[] fromGeometries,
                                       ILongArray[] toNetworkSourceIDs,
                                       IStringArray[] toGlobalIDs,
                                       ILongArray[] toObjectIDs,
                                       ILongArray[] toTerminalIDs,
                                       IArray[] toGeometries)
                                throws java.io.IOException,
                                       AutomationException

Returns connectivity information for trace results.

Specified by:

getTraceResultConnectivity in interface ITraceResults

Parameters:

viaNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

viaGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

viaObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

viaPositionFroms - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

viaPositionTos - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

viaGeometries - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

fromNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

fromGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

fromObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

fromTerminalIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

fromGeometries - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

toNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

toGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

toObjectIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

toTerminalIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

toGeometries - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.