com.esri.arcgis.geodatabase

Interface ITracer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITracerProxy, TNTracerService, UNTracerService

public interface ITracer
extends java.io.Serializable

COM Interface 'ITracer'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to a 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID8a5938f3_74a8_43b9_961c_59083d327137
static int	xxDummy Deprecated. Internal use only

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.
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	initialize(IUtilityNetworkQuery unQuery, IDataElement definition) Initializes the tracer.
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.

Field Detail

IID8a5938f3_74a8_43b9_961c_59083d327137

static final int IID8a5938f3_74a8_43b9_961c_59083d327137

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

initialize

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

Initializes the tracer.

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

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

Adds a trace location.

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

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

Adds trace locations.

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

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

Deletes all trace locations.

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

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

Returns trace locations.

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

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

Adds trace location for junction features.

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

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

Adds trace location for edge features.

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

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

Add the given geometries as trace locations.

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

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

Returns trace configuration.

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

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

Returns trace configuration.

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

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

Returns the result types.

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

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

Returns the result types.

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

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

Execute the given trace.

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

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

Returns trace configuration global ID.

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

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

Returns trace configuration global ID.

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

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

Execute the given trace.

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.