com.esri.arcgis.geodatabase

Class Circuit

java.lang.Object

com.esri.arcgis.geodatabase.Circuit

All Implemented Interfaces:

ICircuit, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class Circuit
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ICircuit

COM Class 'Circuit'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Utility Network Circuit' 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.ICircuit

IID, IIDe2674c0f_42ff_4071_b756_c2e8c48f8ff1, xxDummy

Constructor Summary

Constructors

Constructor and Description
Circuit() Constructs a Circuit using ArcGIS Engine.
Circuit(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Circuit theCircuit = (Circuit) obj;

Method Summary

Modifier and Type	Method and Description
void	addSection(ICircuitSection circuitSection) Adds section.
void	addSubcircuit(ISubcircuit subcircuit) Adds subcircuit.
void	deleteSection(int sectionID) Deletes section.
void	deleteSubcircuit(java.lang.String subcircuitName) Deletes subcircuit.
boolean	equals(java.lang.Object o) Compare this object with another
int	getCircuitType() Returns the circuit type.
static java.lang.String	getClsid() getClsid.
GUID	getGlobalID() Returns the globalID.
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.
java.lang.String	getName() Returns the name.
IArray	getSections() Returns sections.
void	getStartStopPoint(ICircuitPoint startPoint, ICircuitPoint stopPoint) Returns start and stop points.
IArray	getSubcircuits() Returns subcircuits.
int	hashCode() the hashcode for this object
boolean	isSectioned() Returns whether the circuit is sectioned.
void	release() Release this COM object reference
void	setStartStopPoint(ICircuitPoint startPoint, ICircuitPoint stopPoint) Sets start and stop points.

Methods inherited from class java.lang.Object

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

Constructor Detail

Circuit

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

Constructs a Circuit using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Circuit

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

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

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

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

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

getName

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

Returns the name.

Specified by:

getName in interface ICircuit

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobalID

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

Returns the globalID.

Specified by:

getGlobalID in interface ICircuit

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.

isSectioned

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

Returns whether the circuit is sectioned.

Specified by:

isSectioned in interface ICircuit

Returns:

The isSectioned

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCircuitType

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

Returns the circuit type.

Specified by:

getCircuitType in interface ICircuit

Returns:

A com.esri.arcgis.geodatabase.esriCircuitType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSections

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

Returns sections.

Specified by:

getSections in interface ICircuit

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.

addSection

public void addSection(ICircuitSection circuitSection)
                throws java.io.IOException,
                       AutomationException

Adds section.

Specified by:

addSection in interface ICircuit

Parameters:

circuitSection - A reference to a com.esri.arcgis.geodatabase.ICircuitSection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSection

public void deleteSection(int sectionID)
                   throws java.io.IOException,
                          AutomationException

Deletes section.

Specified by:

deleteSection in interface ICircuit

Parameters:

sectionID - The sectionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubcircuits

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

Returns subcircuits.

Specified by:

getSubcircuits in interface ICircuit

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.

addSubcircuit

public void addSubcircuit(ISubcircuit subcircuit)
                   throws java.io.IOException,
                          AutomationException

Adds subcircuit.

Specified by:

addSubcircuit in interface ICircuit

Parameters:

subcircuit - A reference to a com.esri.arcgis.geodatabase.ISubcircuit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSubcircuit

public void deleteSubcircuit(java.lang.String subcircuitName)
                      throws java.io.IOException,
                             AutomationException

Deletes subcircuit.

Specified by:

deleteSubcircuit in interface ICircuit

Parameters:

subcircuitName - The subcircuitName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartStopPoint

public void getStartStopPoint(ICircuitPoint startPoint,
                              ICircuitPoint stopPoint)
                       throws java.io.IOException,
                              AutomationException

Returns start and stop points.

Specified by:

getStartStopPoint in interface ICircuit

Parameters:

startPoint - A reference to a com.esri.arcgis.geodatabase.ICircuitPoint (in)

stopPoint - A reference to a com.esri.arcgis.geodatabase.ICircuitPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartStopPoint

public void setStartStopPoint(ICircuitPoint startPoint,
                              ICircuitPoint stopPoint)
                       throws java.io.IOException,
                              AutomationException

Sets start and stop points.

Specified by:

setStartStopPoint in interface ICircuit

Parameters:

startPoint - A reference to a com.esri.arcgis.geodatabase.ICircuitPoint (in)

stopPoint - A reference to a com.esri.arcgis.geodatabase.ICircuitPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.